KhanShaheb34 / Coterm

Copilot for your terminal

Installation

Automated installation:

curl -s https://coterm.vercel.app/install.sh | bash

This will install the latest version of Coterm and add ct alias for you. If it does not support your platform, please check out Build from source section.

Note that this script will install Coterm in /usr/local/bin directory. It might ask for your password to do so.

Running a script from the internet is not a good idea. Please check the script before running it.

Using Cargo

cargo install coterm

You need to have Rust and Cargo installed to use this method. See here for more information. And this installation does not add ct alias for you. You need to add it manually.

Build from source

• Install Rust and Cargo from here.
• Clone the repository and cd into it.
• Run cargo build --release to build the binary.
• Copy the binary from target/release/coterm to your PATH.

Usage

ct [PROMPT]

For example if you want a list of all typescript files:

ct list ts files

And after the tool generates a command you can add revisions to it, for example:

• ignore node modules
• sort by size
• etc.

Show Help

Check out the help page for more information:

ct -h | --help

Examples

Contributing

We welcome contributions from the community to help improve and enhance Coterm. If you are interested in contributing, please take a moment to review our Contribution Guidelines before submitting your changes. The guidelines provide information on how to report issues, request new features, contribute code, review contributions, and adhere to our code of conduct. We appreciate your support in making Coterm even better and thank you for considering contributing to our project!

Code of Conduct

Please review and abide by our Code of Conduct at all times during your involvement with this project.

License

Coterm is licensed under the GNU GENERAL PUBLIC LICENSE Version 3.