| Name | cdhist JSON |
| Version |
3.7.2
JSON |
| download |
| home_page | |
| Summary | Program to provide a Linux cd history directory stack |
| upload_time | 2023-06-19 04:05:06 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | GPLv3 |
| keywords |
bash
zsh
cd
fzf
git
worktree
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Linux Directory History
[](https://pypi.org/project/cdhist/)
[](https://aur.archlinux.org/packages/cdhist/)
[cdhist](http://github.com/bulletmark/cdhist) is a utility which
provides a Linux shell **cd history** directory stack. A shell `cd`
wrapper function calls cdhist to intercept your typed `cd` command and
maintain an ordered stack of all directories you have previously visited
which can be listed and quickly navigated to.
[cdhist](http://github.com/bulletmark/cdhist) can also be used with the
[Command Line Fuzzy Finder](https://github.com/junegunn/fzf) `fzf` to
fuzzy search and select on previously visited directories, and can be
used to easily `cd` between [`git worktree`](https://git-scm.com/docs/git-worktree)
directories. See the sections below about [FZF
Integration](#fzf-integration) and [Git Worktree
Integration](#git-worktree-integration).
The latest version and documentation is available at
http://github.com/bulletmark/cdhist.
## Example Usage
Use the `cd` command to change directory as normal:
```sh
$ cd /tmp
$ cd /etc
$ cd /usr/share/doc
$ cd /boot/loader
$ cd ~/etc
$ cd
```
At any point you can use the `cd --` command to list all your previously
visited directories and be prompted for one to select and `cd` to:
```
$ cd --
6 ...
5 /tmp
4 /etc
3 /usr/share/doc
2 /boot/loader
1 ~/etc
0 ~
Select index [or <enter> to quit]: 3
$ pwd
/usr/share/doc
```
That's it! The above is all you really need to know. Instead of having
to type the directory name you merely enter it's index. The directories
are displayed most recently visited last, without duplicates. Index 0 is
the current directory, index 1 is the previous, index 2 is the second
previous, up to a user configurable number (default 50). Other available
commands and options are:
List the current stack and its indices (without prompting):
```sh
$ cd -l
```
Change immediately to directory corresponding to stack index 4:
```sh
$ cd -4
```
Search back through stack for directory containing "string" and `cd`
there:
```sh
$ cd -/string
```
Note, you can also type `string` at the `cd --` prompt to search.
Show help/usage:
```sh
$ cd -h
```
## Installation
Arch users can install [cdhist from the
AUR](https://aur.archlinux.org/packages/cdhist/) and skip to the next
section.
Python 3.7 or later is required. Note [cdhist is on
PyPI](https://pypi.org/project/cdhist/) so just ensure that
[`pipx`](https://pypa.github.io/pipx/) is installed then type the
following:
```
$ pipx install cdhist
```
To upgrade:
```
$ pipx upgrade cdhist
```
## Setup
A user who wants to use the cdhist facility should add the following
lines to their `~/.bashrc` or `~/.zshrc` file (after where your PATH is
set up so that the command `cdhist` can be found). This creates the `cd`
wrapper command in your interactive shell session as a tiny function.
Note you can [customize the command name](#alternative-command-name) if
you want.
```sh
if type cdhist &>/dev/null; then
. <(cdhist -i)
fi
```
Then log out and back in again.
## FZF Integration
The popular [Command Line Fuzzy Finder](https://github.com/junegunn/fzf)
`fzf` can easily be integrated with cdhist to provide fuzzy search
navigation over your directory history. Set the following in your
environment to have `fzf` search the directories recorded by cdhist:
```sh
export FZF_ALT_C_COMMAND="cat $HOME/.cd_history"
```
Since `fzf` version 0.31.0, you also should make a small change to the
way you source the `fzf` completion and key-binding files into your
shell, e.g. in your `~/.bashrc`. The following is a typical script to
load `fzf` except the source line must be changed to do an "on the
fly" edit of `builtin cd` to regular `cd`. E.g:
```sh
for _d in /usr/share/fzf /usr/share/fzf/shell /usr/share/doc/fzf/examples \
/usr/share/bash-completion/completions/fzf ; do
if [[ -d $_d ]]; then
for _f in $_d/key-bindings.bash $_d/completion.bash; do
if [[ -f $_f ]]; then
. <(sed 's/builtin cd/cd/' $_f)
fi
done
fi
done
```
After doing this (and reloading your shell session), you can use the
`fzf` key binding `<ALT+C>` to have `fzf` list all your previous
directories and fuzzy match on them for selection as you type. `fzf` can
also provide fancy [directory
previews](https://github.com/junegunn/fzf/wiki/Configuring-shell-key-bindings#preview-1)
using `tree`, etc. Of course the cdhist native command `cd --` and
other cdhist commands described above are still available, in addition
to the `fzf` key binding.
### Pruning Non-Existent Directories
If you prefer that directories that do not exist are excluded from `fzf`
and your `cd` history (i.e. exclude directories that have been deleted
since they were last visited), then you can define the `fzf` command as:
```sh
export FZF_ALT_C_COMMAND="cdhist -p && cat $HOME/.cd_history"
```
An alternative is to always exclude non-existent directories from your
cd history by setting the `--prune-always` as a [default
option](#default-options).
## Alternative Command Name
Some people may prefer not to alias their system `cd` command to this
utility and just use an alternative unique command name. To do this,
simply add your desired command name as an extra argument to the
`cdhist` command in your shell initialization code. E.g, to use the
command name `xd` rather than `cd`, use the following in
your `~/.bashrc` or `~/.zshrc` file:
```sh
if type cdhist &>/dev/null; then
. <(cdhist -i xd)
fi
```
Then log out/in, and then just type `xd /tmp` to change dir, `xd --` to see
and select directories, etc.
## GIT Worktree Integration
[cdhist](http://github.com/bulletmark/cdhist) can be used to easily `cd`
between [git worktree](https://git-scm.com/docs/git-worktree)
directories. You use the `cd -g` command to list all your worktrees and
be prompted for one to select, and then you will be switched to the
associated directory, and it will be added to your `cd` history.
```sh
# Current directory:
$ pwd
/home/mark/src/myprog
# List worktrees using standard git command:
$ git worktree list
/home/mark/src/myprog f76b8e0 [main]
/home/mark/src/development 9796714 [development]
/home/mark/src/milestone1 bc921b8 [milestone1]
/home/mark/src/test e6d965a [test]
# Alternately, use cdhist to list worktrees and choose one to navigate to:
$ cd -g
3 ~/src/development 9796714 [development]
2 ~/src/milestone1 bc921b8 [milestone1]
1 ~/src/test e6d965a [test]
0 ~/src/myprog f76b8e0 [main]
Select index [or <enter> to quit]: 2
$ pwd
/home/mark/src/milestone1
# Or, use cdhist to navigate to worktree dir for given branch name or
# commit:
$ cd -g main
$ pwd
/home/mark/src/myprog
```
Instead of having to type the full git repository directory name you
merely are prompted with a list and enter it's index. Or just directly
enter the branch name (or commit hash). The directories are displayed in
the same order as the output of the `git worktree list` command, except
that the git directory corresponding to the current working directory is
shown first (index 0) consistent with how the current directory is shown
at index 0 for normal cd history and thus conveniently showing you which
git worktree you are currently in which `git worktree list`
unfortunately does not show.
In you enter text instead of an index, you only need to enter as much of
the branch name, or commit hash, as needed to be unique. Note that `cd
-g` nicely presents paths based from your HOME directory with a tilde
(`~`) unlike the longer full path displayed by `git worktree list`
(although you can change that with the `-u/--no-user` option, likely set
as a [default option](#default-options)).
### Relative Git Worktree Directories
The `git worktree list` command displays absolute directory paths, and
cdhist does also by default, but many users prefer them displayed
as relative paths. The Git worktree command does not provide this but
you can enable it in cdhist by adding the `-r/--relative` option, e.g:
```sh
$ cd -gr
3 ../development 9796714 [development]
2 ../milestone1 bc921b8 [milestone1]
1 ../test e6d965a [test]
0 . f76b8e0 [main]
Select index [or <enter> to quit]:
```
Most likely you will want to set this as your default so do that by
adding `--relative` as a [default option](#default-options).
### Git Worktree Functionality Alone
Some users may want the git worktree functionality provided by cdhist
but are not interested in the standard `cd` history functionality, or
alternately, want to use a completely separate command for the git
worktree functionality. To do this, simply add your desired command name
and the git option as an extra argument to the `cdhist` command in your
shell initialization code. E.g, to use the command name `wt` for git
worktree functionality (only), add the following in your
`~/.bashrc` or `~/.zshrc` file:
```sh
if type cdhist &>/dev/null; then
. <(cdhist -i "wt -g")
fi
```
Then log out/in, and then just type `wt` to list the git worktrees and
be prompted to select the directory etc. Of course, you can define this
`wt` command in parallel to using cdhist for your `cd` command if
you want.
## Default Options
There are 2 alternatives to set default cdhist options:
1. Set options in startup configuration file.
2. Set options in shell initialization code.
It's largely personal preference which you choose.
Note if you set `-r/--git-relative` or `-u/--no-user` options as default
then options `-R/--no-git-relative` and `-U/--user` exist to
allow you to temporarily override those defaults.
### Set Options in Startup Configuration File
You can add default options to a personal configuration file
`~/.config/cdhist-flags.conf`. If that file exists then each line in
the file will be concatenated and automatically prepended to your command
line options. The following options are sensible candidates to set as
default options: `--purge-always`, `--git-relative`, `--no-user`,
`--size`. Comments on any line are excluded.
You are best to use the full/long name for options and to add them on
individual lines in the file so they are easy to read and easy to
comment out temporarily etc.
### Set Options in Shell Initialization Code
Alternately, just set your preferred default options in your shell
initialization code, e.g:
```sh
if type cdhist &>/dev/null; then
. <(cdhist -i "cd -arm 200")
fi
```
The above sets `-a (--purge-always)`, `-r (--git-relative)`, and
`-m (--size) 200` options as defaults for your `cd` command. Best to use
the short option names to keep the imported shell function definition
concise.
An advantage of this 2nd approach to setting default options is that you
can create one alias for your `cd` command, and another alias for your
git worktree command (e.g. `wt`), and both can have different cdhist
options.
## Command Line Usage
Type `cdhist -h` to view the usage summary:
```
usage: cdhist [-i] [-h] [-p] [-a] [-g] [-r] [-R] [-u] [-U] [-l] [-m SIZE]
[-n NUM_LINES] [-L] [-P] [-V]
[directory]
A Linux shell directory stack "cd history" function.
positional arguments:
directory directory (or branch for git worktree) to cd to, or
"--" to list history and prompt, or "-n" for n'th
entry in list or "-/<string>" to match for "string" in
dir
options:
-i, --init output shell initialization code. Optionally specify
alternative command name as argument, default="cd"
-h, --help show help/usage
-p, --purge just purge non-existent directories from history
-a, --purge-always always purge non-existent directories every write
-g, --git show git worktree directories instead
-r, --git-relative show relative git worktree paths instead of absolute
-R, --no-git-relative
do not show relative git worktree paths (default)
-u, --no-user do not substitute "~" for home directory
-U, --user do substitute "~" for home directory (default)
-l, --list just list directory history
-m SIZE, --size SIZE maximum size of directory history (default=50)
-n NUM_LINES, --num-lines NUM_LINES
limit output to specified number of lines
-L, --follow-links follow symbolic links (default=true)
-P, --follow-physical
follow links to physical directory
-V, --version just output cdhist version
Note you can set default options in ~/.config/cdhist-flags.conf.
```
## Limitations
Regular `cd`, e.g. as provided by the bash builtin, offers some esoteric
command line options such as `-e` and `-@`, and shell options such as
`autocd`, `cdspell`, `cdable_vars`. These rarely used options are not
supported by cdhist.
## Major Version Change History
Version 3.0 changes and new features:
1. Added function to `cd` between [`git
worktrees`](https://git-scm.com/docs/git-worktree). Can configure this
as separate command if preferred, with option to display relative paths.
2. Cleaner installation using `-i` option so no need for separate
`cdhist.rc` file and can set arguments when installing to customise
command name + options etc.
3. Added `-L`/`-P` standard `cd` options.
4. Added `-a/--purge-always` option to always prune history.
5. Add `-n/--num-lines` to limit number of lines in output (for
`-l/--list` and `--` commands).
6. Added ability to set default options in
`~/.config/cdhist-flags.conf`.
7. Parses options/arguments using standard Python argparse.
8. Let setuptools build the main program stub rather than install our
own.
9. Min Python version up from 3.4 to 3.7.
10. Now installed as a Python package (directory) rather than a module
(single file).
11. Some of these changes slow the program down but architecture is
changed so the program is run once only, not twice as it ran before.
Second run was to save the new directory after `cd` had validated it,
but now we validate it ourself before passing to `cd`. So net
performance is quicker than previous version, at least for the vanilla
case of changing directory. This is not noticeable on normal PC's but is
on constrained platforms like Raspberry Pi 2/3 using SD card.
12. If you were previously setting `CDHISTSIZE` or `CDHISTTILDE` settings
via environment variables then you now need to set them using `--size`
and `--no-user` in `~/.config/cdhist-flags.conf`, or add those options
in your shell initialization code.
13. The `-s` option to return a `cdhist.rc` file name for initialisation
is still currently supported for backwards-compatibility but is
undocumented and depreciated (a temporary file is created and returned).
It will likely eventually be removed.
## License
Copyright (C) 2010 Mark Blakeney. This program is distributed under the
terms of the GNU General Public License.
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or any later
version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License at <http://www.gnu.org/licenses/> for more details.
Raw data
{
"_id": null,
"home_page": "",
"name": "cdhist",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "bash,zsh,cd,fzf,git,worktree",
"author": "",
"author_email": "Mark Blakeney <mark.blakeney@bullet-systems.net>",
"download_url": "https://files.pythonhosted.org/packages/6c/30/43e1a8d577f4de6ce327adab2c9feaa3498d9321e8ed691edbf931bdb46a/cdhist-3.7.2.tar.gz",
"platform": null,
"description": "## Linux Directory History\n[](https://pypi.org/project/cdhist/)\n[](https://aur.archlinux.org/packages/cdhist/)\n\n[cdhist](http://github.com/bulletmark/cdhist) is a utility which\nprovides a Linux shell **cd history** directory stack. A shell `cd`\nwrapper function calls cdhist to intercept your typed `cd` command and\nmaintain an ordered stack of all directories you have previously visited\nwhich can be listed and quickly navigated to.\n\n[cdhist](http://github.com/bulletmark/cdhist) can also be used with the\n[Command Line Fuzzy Finder](https://github.com/junegunn/fzf) `fzf` to\nfuzzy search and select on previously visited directories, and can be\nused to easily `cd` between [`git worktree`](https://git-scm.com/docs/git-worktree)\ndirectories. See the sections below about [FZF\nIntegration](#fzf-integration) and [Git Worktree\nIntegration](#git-worktree-integration).\n\nThe latest version and documentation is available at\nhttp://github.com/bulletmark/cdhist.\n\n## Example Usage\n\nUse the `cd` command to change directory as normal:\n\n```sh\n$ cd /tmp\n$ cd /etc\n$ cd /usr/share/doc\n$ cd /boot/loader\n$ cd ~/etc\n$ cd\n```\n\nAt any point you can use the `cd --` command to list all your previously\nvisited directories and be prompted for one to select and `cd` to:\n\n```\n$ cd --\n 6 ...\n 5 /tmp\n 4 /etc\n 3 /usr/share/doc\n 2 /boot/loader\n 1 ~/etc\n 0 ~\nSelect index [or <enter> to quit]: 3\n$ pwd\n/usr/share/doc\n```\n\nThat's it! The above is all you really need to know. Instead of having\nto type the directory name you merely enter it's index. The directories\nare displayed most recently visited last, without duplicates. Index 0 is\nthe current directory, index 1 is the previous, index 2 is the second\nprevious, up to a user configurable number (default 50). Other available\ncommands and options are:\n\nList the current stack and its indices (without prompting):\n\n```sh\n$ cd -l\n```\n\nChange immediately to directory corresponding to stack index 4:\n\n```sh\n$ cd -4\n```\n\nSearch back through stack for directory containing \"string\" and `cd`\nthere:\n\n```sh\n$ cd -/string\n```\n\nNote, you can also type `string` at the `cd --` prompt to search.\n\nShow help/usage:\n\n```sh\n$ cd -h\n```\n\n## Installation\n\nArch users can install [cdhist from the\nAUR](https://aur.archlinux.org/packages/cdhist/) and skip to the next\nsection.\n\nPython 3.7 or later is required. Note [cdhist is on\nPyPI](https://pypi.org/project/cdhist/) so just ensure that\n[`pipx`](https://pypa.github.io/pipx/) is installed then type the\nfollowing:\n\n```\n$ pipx install cdhist\n```\n\nTo upgrade:\n\n```\n$ pipx upgrade cdhist\n```\n\n## Setup\n\nA user who wants to use the cdhist facility should add the following\nlines to their `~/.bashrc` or `~/.zshrc` file (after where your PATH is\nset up so that the command `cdhist` can be found). This creates the `cd`\nwrapper command in your interactive shell session as a tiny function.\nNote you can [customize the command name](#alternative-command-name) if\nyou want.\n\n```sh\nif type cdhist &>/dev/null; then\n . <(cdhist -i)\nfi\n```\n\nThen log out and back in again.\n\n## FZF Integration\n\nThe popular [Command Line Fuzzy Finder](https://github.com/junegunn/fzf)\n`fzf` can easily be integrated with cdhist to provide fuzzy search\nnavigation over your directory history. Set the following in your\nenvironment to have `fzf` search the directories recorded by cdhist:\n\n```sh\nexport FZF_ALT_C_COMMAND=\"cat $HOME/.cd_history\"\n```\n\nSince `fzf` version 0.31.0, you also should make a small change to the\nway you source the `fzf` completion and key-binding files into your\nshell, e.g. in your `~/.bashrc`. The following is a typical script to\nload `fzf` except the source line must be changed to do an \"on the\nfly\" edit of `builtin cd` to regular `cd`. E.g:\n\n```sh\nfor _d in /usr/share/fzf /usr/share/fzf/shell /usr/share/doc/fzf/examples \\\n /usr/share/bash-completion/completions/fzf ; do\n if [[ -d $_d ]]; then\n for _f in $_d/key-bindings.bash $_d/completion.bash; do\n if [[ -f $_f ]]; then\n . <(sed 's/builtin cd/cd/' $_f)\n fi\n done\n fi\ndone\n```\n\nAfter doing this (and reloading your shell session), you can use the\n`fzf` key binding `<ALT+C>` to have `fzf` list all your previous\ndirectories and fuzzy match on them for selection as you type. `fzf` can\nalso provide fancy [directory\npreviews](https://github.com/junegunn/fzf/wiki/Configuring-shell-key-bindings#preview-1)\nusing `tree`, etc. Of course the cdhist native command `cd --` and\nother cdhist commands described above are still available, in addition\nto the `fzf` key binding.\n\n### Pruning Non-Existent Directories\nIf you prefer that directories that do not exist are excluded from `fzf`\nand your `cd` history (i.e. exclude directories that have been deleted\nsince they were last visited), then you can define the `fzf` command as:\n\n```sh\nexport FZF_ALT_C_COMMAND=\"cdhist -p && cat $HOME/.cd_history\"\n```\n\nAn alternative is to always exclude non-existent directories from your\ncd history by setting the `--prune-always` as a [default\noption](#default-options).\n\n## Alternative Command Name\n\nSome people may prefer not to alias their system `cd` command to this\nutility and just use an alternative unique command name. To do this,\nsimply add your desired command name as an extra argument to the\n`cdhist` command in your shell initialization code. E.g, to use the\ncommand name `xd` rather than `cd`, use the following in\nyour `~/.bashrc` or `~/.zshrc` file:\n\n```sh\nif type cdhist &>/dev/null; then\n . <(cdhist -i xd)\nfi\n```\n\nThen log out/in, and then just type `xd /tmp` to change dir, `xd --` to see\nand select directories, etc.\n\n## GIT Worktree Integration\n\n[cdhist](http://github.com/bulletmark/cdhist) can be used to easily `cd`\nbetween [git worktree](https://git-scm.com/docs/git-worktree)\ndirectories. You use the `cd -g` command to list all your worktrees and\nbe prompted for one to select, and then you will be switched to the\nassociated directory, and it will be added to your `cd` history.\n\n```sh\n# Current directory:\n$ pwd\n/home/mark/src/myprog\n\n# List worktrees using standard git command:\n$ git worktree list\n/home/mark/src/myprog f76b8e0 [main]\n/home/mark/src/development 9796714 [development]\n/home/mark/src/milestone1 bc921b8 [milestone1]\n/home/mark/src/test e6d965a [test]\n\n# Alternately, use cdhist to list worktrees and choose one to navigate to:\n$ cd -g\n 3 ~/src/development 9796714 [development]\n 2 ~/src/milestone1 bc921b8 [milestone1]\n 1 ~/src/test e6d965a [test]\n 0 ~/src/myprog f76b8e0 [main]\nSelect index [or <enter> to quit]: 2\n\n$ pwd\n/home/mark/src/milestone1\n\n# Or, use cdhist to navigate to worktree dir for given branch name or\n# commit:\n$ cd -g main\n$ pwd\n/home/mark/src/myprog\n\n```\n\nInstead of having to type the full git repository directory name you\nmerely are prompted with a list and enter it's index. Or just directly\nenter the branch name (or commit hash). The directories are displayed in\nthe same order as the output of the `git worktree list` command, except\nthat the git directory corresponding to the current working directory is\nshown first (index 0) consistent with how the current directory is shown\nat index 0 for normal cd history and thus conveniently showing you which\ngit worktree you are currently in which `git worktree list`\nunfortunately does not show.\n\nIn you enter text instead of an index, you only need to enter as much of\nthe branch name, or commit hash, as needed to be unique. Note that `cd\n-g` nicely presents paths based from your HOME directory with a tilde\n(`~`) unlike the longer full path displayed by `git worktree list`\n(although you can change that with the `-u/--no-user` option, likely set\nas a [default option](#default-options)).\n\n### Relative Git Worktree Directories\n\nThe `git worktree list` command displays absolute directory paths, and\ncdhist does also by default, but many users prefer them displayed\nas relative paths. The Git worktree command does not provide this but\nyou can enable it in cdhist by adding the `-r/--relative` option, e.g:\n\n```sh\n$ cd -gr\n 3 ../development 9796714 [development]\n 2 ../milestone1 bc921b8 [milestone1]\n 1 ../test e6d965a [test]\n 0 . f76b8e0 [main]\nSelect index [or <enter> to quit]:\n```\n\nMost likely you will want to set this as your default so do that by\nadding `--relative` as a [default option](#default-options).\n\n### Git Worktree Functionality Alone\n\nSome users may want the git worktree functionality provided by cdhist\nbut are not interested in the standard `cd` history functionality, or\nalternately, want to use a completely separate command for the git\nworktree functionality. To do this, simply add your desired command name\nand the git option as an extra argument to the `cdhist` command in your\nshell initialization code. E.g, to use the command name `wt` for git\nworktree functionality (only), add the following in your\n`~/.bashrc` or `~/.zshrc` file:\n\n```sh\nif type cdhist &>/dev/null; then\n . <(cdhist -i \"wt -g\")\nfi\n```\n\nThen log out/in, and then just type `wt` to list the git worktrees and\nbe prompted to select the directory etc. Of course, you can define this\n`wt` command in parallel to using cdhist for your `cd` command if\nyou want.\n\n## Default Options\n\nThere are 2 alternatives to set default cdhist options:\n\n1. Set options in startup configuration file.\n2. Set options in shell initialization code.\n\nIt's largely personal preference which you choose.\n\nNote if you set `-r/--git-relative` or `-u/--no-user` options as default\nthen options `-R/--no-git-relative` and `-U/--user` exist to\nallow you to temporarily override those defaults.\n\n### Set Options in Startup Configuration File\n\nYou can add default options to a personal configuration file\n`~/.config/cdhist-flags.conf`. If that file exists then each line in\nthe file will be concatenated and automatically prepended to your command\nline options. The following options are sensible candidates to set as\ndefault options: `--purge-always`, `--git-relative`, `--no-user`,\n`--size`. Comments on any line are excluded.\n\nYou are best to use the full/long name for options and to add them on\nindividual lines in the file so they are easy to read and easy to\ncomment out temporarily etc.\n\n### Set Options in Shell Initialization Code\n\nAlternately, just set your preferred default options in your shell\ninitialization code, e.g:\n\n```sh\nif type cdhist &>/dev/null; then\n . <(cdhist -i \"cd -arm 200\")\nfi\n```\n\nThe above sets `-a (--purge-always)`, `-r (--git-relative)`, and\n`-m (--size) 200` options as defaults for your `cd` command. Best to use\nthe short option names to keep the imported shell function definition\nconcise.\n\nAn advantage of this 2nd approach to setting default options is that you\ncan create one alias for your `cd` command, and another alias for your\ngit worktree command (e.g. `wt`), and both can have different cdhist\noptions.\n\n## Command Line Usage\n\nType `cdhist -h` to view the usage summary:\n\n```\nusage: cdhist [-i] [-h] [-p] [-a] [-g] [-r] [-R] [-u] [-U] [-l] [-m SIZE]\n [-n NUM_LINES] [-L] [-P] [-V]\n [directory]\n\nA Linux shell directory stack \"cd history\" function.\n\npositional arguments:\n directory directory (or branch for git worktree) to cd to, or\n \"--\" to list history and prompt, or \"-n\" for n'th\n entry in list or \"-/<string>\" to match for \"string\" in\n dir\n\noptions:\n -i, --init output shell initialization code. Optionally specify\n alternative command name as argument, default=\"cd\"\n -h, --help show help/usage\n -p, --purge just purge non-existent directories from history\n -a, --purge-always always purge non-existent directories every write\n -g, --git show git worktree directories instead\n -r, --git-relative show relative git worktree paths instead of absolute\n -R, --no-git-relative\n do not show relative git worktree paths (default)\n -u, --no-user do not substitute \"~\" for home directory\n -U, --user do substitute \"~\" for home directory (default)\n -l, --list just list directory history\n -m SIZE, --size SIZE maximum size of directory history (default=50)\n -n NUM_LINES, --num-lines NUM_LINES\n limit output to specified number of lines\n -L, --follow-links follow symbolic links (default=true)\n -P, --follow-physical\n follow links to physical directory\n -V, --version just output cdhist version\n\nNote you can set default options in ~/.config/cdhist-flags.conf.\n```\n\n## Limitations\n\nRegular `cd`, e.g. as provided by the bash builtin, offers some esoteric\ncommand line options such as `-e` and `-@`, and shell options such as\n`autocd`, `cdspell`, `cdable_vars`. These rarely used options are not\nsupported by cdhist.\n\n## Major Version Change History\n\nVersion 3.0 changes and new features:\n\n1. Added function to `cd` between [`git\nworktrees`](https://git-scm.com/docs/git-worktree). Can configure this\nas separate command if preferred, with option to display relative paths.\n\n2. Cleaner installation using `-i` option so no need for separate\n`cdhist.rc` file and can set arguments when installing to customise\ncommand name + options etc.\n\n3. Added `-L`/`-P` standard `cd` options.\n\n4. Added `-a/--purge-always` option to always prune history.\n\n5. Add `-n/--num-lines` to limit number of lines in output (for\n`-l/--list` and `--` commands).\n\n6. Added ability to set default options in\n`~/.config/cdhist-flags.conf`.\n\n7. Parses options/arguments using standard Python argparse.\n\n8. Let setuptools build the main program stub rather than install our\nown.\n\n9. Min Python version up from 3.4 to 3.7.\n\n10. Now installed as a Python package (directory) rather than a module\n(single file).\n\n11. Some of these changes slow the program down but architecture is\nchanged so the program is run once only, not twice as it ran before.\nSecond run was to save the new directory after `cd` had validated it,\nbut now we validate it ourself before passing to `cd`. So net\nperformance is quicker than previous version, at least for the vanilla\ncase of changing directory. This is not noticeable on normal PC's but is\non constrained platforms like Raspberry Pi 2/3 using SD card.\n\n12. If you were previously setting `CDHISTSIZE` or `CDHISTTILDE` settings\nvia environment variables then you now need to set them using `--size`\nand `--no-user` in `~/.config/cdhist-flags.conf`, or add those options\nin your shell initialization code.\n\n13. The `-s` option to return a `cdhist.rc` file name for initialisation\nis still currently supported for backwards-compatibility but is\nundocumented and depreciated (a temporary file is created and returned).\nIt will likely eventually be removed.\n\n## License\n\nCopyright (C) 2010 Mark Blakeney. This program is distributed under the\nterms of the GNU General Public License.\nThis program is free software: you can redistribute it and/or modify it\nunder the terms of the GNU General Public License as published by the\nFree Software Foundation, either version 3 of the License, or any later\nversion.\nThis program is distributed in the hope that it will be useful, but\nWITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General\nPublic License at <http://www.gnu.org/licenses/> for more details.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Program to provide a Linux cd history directory stack",
"version": "3.7.2",
"project_urls": {
"Homepage": "https://github.com/bulletmark/cdhist"
},
"split_keywords": [
"bash",
"zsh",
"cd",
"fzf",
"git",
"worktree"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "299f074c539f5f324ddab317259fe708d4773e7b0801f11e428242575a547f05",
"md5": "3290879650f62f33087fd645baf1ae4d",
"sha256": "5fa212de3b749620651af25561dc169ec65f78dfa05a9e0d456b2c684789a5c4"
},
"downloads": -1,
"filename": "cdhist-3.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3290879650f62f33087fd645baf1ae4d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13807,
"upload_time": "2023-06-19T04:05:05",
"upload_time_iso_8601": "2023-06-19T04:05:05.029290Z",
"url": "https://files.pythonhosted.org/packages/29/9f/074c539f5f324ddab317259fe708d4773e7b0801f11e428242575a547f05/cdhist-3.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6c3043e1a8d577f4de6ce327adab2c9feaa3498d9321e8ed691edbf931bdb46a",
"md5": "321c3e5fc9ab5b65274c9b712160fbbf",
"sha256": "ebaa064b32d09926f20ef54976e179d8a9f52f4937f46ab8d903ac7b8c32a155"
},
"downloads": -1,
"filename": "cdhist-3.7.2.tar.gz",
"has_sig": false,
"md5_digest": "321c3e5fc9ab5b65274c9b712160fbbf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 18681,
"upload_time": "2023-06-19T04:05:06",
"upload_time_iso_8601": "2023-06-19T04:05:06.987608Z",
"url": "https://files.pythonhosted.org/packages/6c/30/43e1a8d577f4de6ce327adab2c9feaa3498d9321e8ed691edbf931bdb46a/cdhist-3.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 04:05:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bulletmark",
"github_project": "cdhist",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cdhist"
}
