https://github.com/nicorobo/dirbook
:book: A tool I use to organize my directories/projects in the terminal.
https://github.com/nicorobo/dirbook
bashrc cli organization productivity
Last synced: 23 days ago
JSON representation
:book: A tool I use to organize my directories/projects in the terminal.
- Host: GitHub
- URL: https://github.com/nicorobo/dirbook
- Owner: nicorobo
- Created: 2017-02-20T04:48:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-21T18:34:59.000Z (almost 8 years ago)
- Last Synced: 2025-01-07T22:51:38.482Z (about 1 month ago)
- Topics: bashrc, cli, organization, productivity
- Language: JavaScript
- Homepage:
- Size: 1.67 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - nicorobo/dirbook - :book: A tool I use to organize my directories/projects in the terminal. (JavaScript)
README
# dirbook
Dirbook is a small CLI created to help index directories/projects.
npm install -g dirbook
* Index directories, giving them names, short descriptions, and tags
* Copy an indexed directory to the current directory, giving it a new name (great for small starter-projects)
* Open an indexed directory in Finder/File Explorer
* Use tags to organize and filter directories
* Turn on aliasing to have dirbook manage a small subsection of your .bash\_profile or .bashrc, creating aliases to cd into directories.
### `add`
`dirbook add` will index the current working directory, after asking you a few questions (name, description, tags).
### `copy [-t --tag ]`
`dirbook copy` displays a list of all indexed directories. After selecting one and giving your new directory a name, a copy will be made in your current working directory.
### `open [-t --tag ]`
`dirbook open` displays a list of all indexed directories. After selecting one, the directory will be opened in the default file browsing app.
### `select [-t --tag ]`
`dirbook select` displays a list of all indexed directories. After selecting one or many, you will be given a few options. If more than one is chosen, their tags may be updated, or they may be deleted from dirbook. If only one is chosen, it may also be updated.
### `ls [-t --tag ]`
`dirbook ls` and `dirbook` prints all indexed directories. This is the default behavior.
### `alias [-o --active, -f --off, -x --prefix , -p --path ]`
Just calling `dirbook alias` will print out the current alias settings (on/off, path to write to, prefix for alias).
Aliasing is off by default, and may be turned on by running `dirbook alias -o`.
For aliasing to work, you will also need to give it the absolute path of the file you'd like to add aliases to. For most this will be **.bash_profile** or **.bashrc**.
Aliases will be given a prefix of `dirbook-` by default to avoid overriding other command, but can be changed using `dirbook alias -x `
Turning aliasing **on** will add an alias for ever indexed directory, using the form `alias = 'cd '`
Turning aliasing off will remove all aliases from **
# dirbook-aliases-start
alias dirbook-element-calc='cd /Users/nickroberts404/Development/Projects/element-calc'
alias dirbook-thoughtjar='cd /Users/nickroberts404/Development/Projects/thoughtjar'
alias dirbook-telegraph='cd /Users/nickroberts404/Development/Projects/Telegraph'
# dirbook-aliases-end
*(Aliases will only be available after restarting the terminal, or after calling `source `.)*
### `reset`
`dirbook reset` will clear dirbook and remove aliases.
Usage: dirbook [options] [command]
Commands:
open [options] Open the selected directory in Finder/File Explorer.
add Add current directory to dirbook.
copy [options] Allows you to select directory to copy.
select [options] Allows you to select directories and perform actions.
ls [options] List all the things.
alias [options] Configure alias settings
reset Wipes dirbook's memory.
Options:
-h, --help output usage information
-V, --version output the version number