https://github.com/eugenesvk/xontrib-cd

'cd' to any path without escaping in xonsh shell: cd ~/[te] st
https://github.com/eugenesvk/xontrib-cd

cli command-line terminal xonsh xontrib

Last synced: about 2 months ago
JSON representation

'cd' to any path without escaping in xonsh shell: cd ~/[te] st

• Host: GitHub
• URL: https://github.com/eugenesvk/xontrib-cd
• Owner: eugenesvk
• License: mit
• Created: 2021-02-20T10:37:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-20T10:36:07.000Z (2 months ago)
• Last Synced: 2024-07-20T14:44:27.147Z (2 months ago)
• Topics: cli, command-line, terminal, xonsh, xontrib
• Language: Python
• Homepage:
• Size: 28.3 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md
  • License: License

Awesome Lists containing this project

• awesome-xontribs - cd - 'cd' to any path without escaping in xonsh shell ('cd '→'cd! '). (Directory Navigation)

README

        


cd to any path without escaping in xonsh shell.




Replaces cd  at the start of a line with a subprocess macro cd!  



  

If you like the idea click ⭐ on the repo and stay tuned.



## Install

```xsh

xpip install xontrib-cd

# or: xpip install -U git+https://github.com/eugenesvk/xontrib-cd

```

This xontrib will get loaded automatically for interactive sessions; to stop this, set

```xonsh

$XONTRIBS_AUTOLOAD_DISABLED = {"cd", }

```

## Configure

Set the following environment variables in your profile to enable __extra options__ (disabled by default):

  - `$XONTRIB_CD_ALTSYMLINKFLAG = True` to pass `-p`, `-f`, or `-s` flags (in addition to `-P`) to follow symlinks

  - `$XONTRIB_CD_ALTSYMLINKFUNC = True` to use `cdp`, `cdf`, or `cds` (in addition to `cd -P`) to follow symlinks

  - `$XONTRIB_CD_SYMLINKAlWAYSON = True` to make `cd` always follow symlinks (always pass `-P`)

  - `$XONTRIB_CD_LASTCMD = True` to make `cd` also work when it's the last command in a multi-command line

## Use

Use `cd` as usual, but without the fear of copying&pasting arbitrary paths (e.g. `.../space separated/` or `.../[bracketed]/`)

```xsh

xontrib load cd

cd ~/[Path] With Spaces	# equivalent to 'cd! ~/[Path] With Spaces'

cd C:/Program Files    	# equivalent to 'cd! C:/Program Files'

cd -P ~/SymlinkTo      	# follow symlinks, equivalent to 'cd -P! ~/SymlinkTo'

```

Add a space before ` cd` to disable adding `!`

## Known issues

- Xontrib autoload can't be disabled and prevents user configured environment vars from being read on time due to a [xonsh bug](https://github.com/xonsh/xonsh/issues/5020), so if you want to change the default configs via env vars, install the deauto branch `xpip install -U git+https://github.com/eugenesvk/xontrib-cd@deauto`

- Multiple commands per line like `cd ~; echo 1` will fail since `cd` is replaced with `cd!`, and everything after `!` is treated as a single string argument, ignoring the `;` separators

- But `echo 1; cd ~` will work with `$XONTRIB_CD_LASTCMD`

## Credits

This package was created with [xontrib cookiecutter template](https://github.com/xonsh/xontrib-cookiecutter) based on the idea of hooking into the command line input as implemented in [xontrib-sh](https://github.com/anki-code/xontrib-sh)