https://github.com/aergonaut/gear
A CLI tool to improve developer QOL
https://github.com/aergonaut/gear
cli productivity
Last synced: 22 days ago
JSON representation
A CLI tool to improve developer QOL
- Host: GitHub
- URL: https://github.com/aergonaut/gear
- Owner: aergonaut
- License: apache-2.0
- Created: 2019-08-19T07:15:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T23:37:22.000Z (over 2 years ago)
- Last Synced: 2025-02-13T05:15:34.287Z (2 months ago)
- Topics: cli, productivity
- Language: Rust
- Homepage: https://aergonaut.github.io/gear/gear/index.html
- Size: 11.6 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# `gear`
`gear` is a CLI tool to improve developer QOL.
**Caveat lector:** `gear` is highly customized to my workflow. While it is open
source and you may use it if you like, please be aware that YMMV if your
workflow is not nearly exactly (if not exactly) the same as mine.
## Installation
### Binary releases
Binary releases are available for macOS, Linux, and Windows on the [Releases][]
tab.
[releases]: https://github.com/aergonaut/gear/releases
1. Download the appropriate release asset for your platform
2. Unzip the archive
3. Move the `gear` executable somewhere in your path
### With `cargo install`
Run `cargo install --git https://github.com/aergonaut/gear.git`
### From source
1. Clone the repository.
2. Build with `cargo build --release`
3. Move `target/release/gear` somewhere in your path
## Usage
See `gear help` or `gear help [SUBCOMMAND]` for usage information.
Documentation is also available [online](https://aergonaut.github.io/gear/gear/index.html).
## Configuration
`gear` will search for a `gear.toml` file, starting in the current directory and
walking back to the root directory, to read configuration values. The first
file that is found is the one that will be used.
Additionally, a global configuration file is used to store other properties. It
is stored in a canonical location, according to the platform:
- on Linux: `$XDG_CONFIG_HOME/gear/config.toml` or `$HOME/.config/gear/config.toml`
- on Windows: `{FOLDERID_RoamingAppData}/gear/config/config.toml`
- on macOS: `$HOME/Library/Preferences/gear/config.toml`
## License
Licensed under either of these:
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
https://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
https://opensource.org/licenses/MIT)
### Contributing
Unless you explicitly state otherwise, any contribution you intentionally submit
for inclusion in the work, as defined in the Apache-2.0 license, shall be
dual-licensed as above, without any additional terms or conditions.
