Home Explore Blog CI



nushell

1st chunk of `commands/docs/describe.md`
cee9f4a3436582a61814a992eb5abfca5919ce94fd1de223000000010000157b
---
title: describe
categories: |
  core
version: 0.104.0
core: |
  Describe the type and structure of the value(s) piped in.
usage: |
  Describe the type and structure of the value(s) piped in.
editLink: false
contributors: false
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# `describe` for [core](/commands/categories/core.md)

<div class='command-title'>Describe the type and structure of the value(s) piped in.</div>

## Signature

```> describe {flags} ```

## Flags

 -  `--no-collect, -n`: do not collect streams of structured data
 -  `--detailed, -d`: show detailed information about the value


## Input/output types:

| input | output |
| ----- | ------ |
| any   | any    |
## Examples

Describe the type of a string
```nu
> 'hello' | describe
string
```

Describe the type of a record in a detailed way
```nu
> {shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d
╭───────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ type          │ record                                                                                              │
│ detailed_type │ record<shell: string, uwu: bool, features: record<bugs: bool, multiplatform: bool, speed: int>,     │
│               │ fib: list<int>, on_save: closure, first_commit: datetime, my_duration: duration>                    │
│               │ ╭──────────────┬──────────────────────────────────────────────────────────────────────────────────╮ │
│ columns       │ │              │ ╭───────────────┬────────────────────────╮                                       │ │
│               │ │ shell        │ │ type          │ string                 │                                       │ │
│               │ │              │ │ detailed_type │ string                 │                                       │ │
│               │ │              │ │ rust_type     │ &alloc::string::String │                                       │ │
│               │ │              │ │ value         │ true                   │                                       │ │
│               │ │              │ ╰───────────────┴────────────────────────╯                                       │ │
│               │ │              │ ╭───────────────┬──────╮                                                         │ │
│               │ │ uwu          │ │ type          │ bool │                                                         │ │
│               │ │              │ │ detailed_type │ bool │                                                         │ │
│               │ │              │ │ rust_type     │ bool │                                                         │ │
│               │ │              │ │ value         │ true │                                                         │ │
│               │ │              │ ╰───────────────┴──────╯                                                         │ │
│               │ │              │ ╭───────────────┬──────────────────────────────────────────────────────────────╮ │ │
│               │ │ features     │ │ type          │ record                                                       │ │ │
│               │ │              │ │ detailed_type │ record<bugs: bool, multiplatform: bool, speed: int>          │ │ │
│               │ │              │ │               │ ╭───────────────┬───────────────────────────╮                │ │ │
│               │ │              │ │ columns       │ │               │ ╭───────────────┬───────╮ │                │ │ │
│               │ │              │ │               │ │ bugs          │ │ type          │ bool  │ │                │ │ │
│               │ │              │ │               │ │               │ │ detailed_type │ bool  │ │                │ │ │
│               │ │              │ │               │ │               │ │ rust_type     │ bool  │ │                │ │ │

Title: describe command in Nushell
Summary
The `describe` command in Nushell is used to determine the type and structure of piped values. It can provide basic type information or, with the `-d` flag, offer a detailed breakdown of records, including column types and values. The `-n` flag prevents the command from collecting streams of structured data.