ci

README

ci - Interactive cd

ci is an interactive version of the familiar cd command. Easily traverse directories in the terminal without having to cycle between cd and ls.

Demo

Installation

Download and extract the latest release package for your operating system and run the installation script from the extracted location.

Linux (Bash)

# Install
./install.sh

# Uninstall
./uninstall.sh

Windows (PowerShell)

# Install
.\install.ps1

# Uninstall
.\uninstall.ps1

Alternatively, you can build from source from either the release's source archive or from a git clone.

# TODO: Create a build command or makefile for others to build the project themselves.

Usage

# Open a terminal GUI to traverse directories
ci

# Get help
ci -h
ci --help

# Check version information
ci -v
ci --version

Basic controls

• Left and right arrows navigate to parent and child directories respectively
• Up and down arrows select different child directories or menu items
• Enter navigates to the selected directory and exits
• q quits without navigating
• Press h to view additional keymappings and information

Support

If you discover an issue while using or contributing to ci, please open an issue. For all other inquiries or comments, please use the following in order of increasingly general requests/concerns:

• GitHub Discussion Page
• Email

Roadmap

See the open issues and give a thumbs up for those you would like to see resolved first. How much positive attention an issue has plays a role in how soon it gets released. Showstopping defects/bugs always have top priority.

Contributing

There are several ways you can contribute to ci. You can do so by:

• Creating new issues if you find any defects, or if there is a feature you would like implemented.
• Forking the project and creating pull requests. Please see the contributing guidelines for more information.
• Donating to help fund project maintenance and to support an independent developer. (TBD)
• Giving ci a GitHub star if you've found it helpful.

Acknowledgements

Special thanks goes to these resources and tools, without which ci would not have been made possible.

• JetBrains GoLand
• tview
• Tcell
• go-flags
• semantic-release
• commitizen for helping to keep ci's commits clean
• ... and all the resources credited throughout the source code

Feel free to reach out if you discover a resource that hasn't been properly acknowledged here.

License

ci is MIT licensed.