extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-12 08:50:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Auto-generate markdown command docs (#4451)

Browse Source 
* Finish updating

* a couple improvements

* Update renames

* cleanup examples
This commit is contained in:
JT
2022-02-13 21:22:51 -05:00
committed by GitHub
parent 06f5affc0b
commit 8c0a2d3c15
478 changed files with 7676 additions and 8045 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
docs/commands/enter.md
View File

@ -1,58 +1,16 @@
# enter
---
title: enter
layout: command
version: 0.59.0
---
This command creates a new shell and begin at this path.
Enters a new shell at the given path.
## Examples
## Signature
```shell
/home/foobar> cat user.json
{
"Name": "Peter",
"Age": 30,
"Telephone": 88204828,
"Country": "Singapore"
}
/home/foobar> enter user.json
/> ls
━━━━━━━┯━━━━━┯━━━━━━━━━━━┯━━━━━━━━━━━
Name │ Age │ Telephone │ Country
───────┼─────┼───────────┼───────────
Peter │ 30 │ 88204828 │ Singapore
━━━━━━━┷━━━━━┷━━━━━━━━━━━┷━━━━━━━━━━━
/> exit
/home/foobar>
```
```> enter (path)```
It also provides the ability to work with multiple directories at the same time. This command will allow you to create a new "shell" and enter it at the specified path. You can toggle between this new shell and the original shell with the `p` (for previous) and `n` (for next), allowing you to navigate around a ring buffer of shells. Once you're done with a shell, you can `exit` it and remove it from the ring buffer.
## Parameters
```shell
/> enter /tmp
/tmp> enter /usr
/usr> enter /bin
/bin> enter /opt
/opt> p
/bin> p
/usr> p
/tmp> p
/> n
/tmp>
```
- `path`: the path to enter as a new shell
## Note
If you `enter` a JSON file with multiple a top-level list, this will open one new shell for each list element.
```shell
/private/tmp> printf "1\\n2\\n3\\n" | lines | save foo.json
/private/tmp> enter foo.json
/> shells
───┬────────┬─────────────────────────┬──────────────
# │ active │ name │ path
───┼────────┼─────────────────────────┼──────────────
0 │ │ filesystem │ /private/tmp
1 │ │ {/private/tmp/foo.json} │ /
2 │ │ {/private/tmp/foo.json} │ /
3 │ X │ {/private/tmp/foo.json} │ /
───┴────────┴─────────────────────────┴──────────────
/>
```