Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 1.61 KB

README.md

File metadata and controls

87 lines (59 loc) · 1.61 KB
Raw

Utils CLI

Utils CLI is a powerful command-line interface (CLI) tool designed to supercharge your productivity by providing essential utilities for software projects. This tool supports storing key-value pairs, generating .gitignore files, managing README files, and more. Utils CLI is lightweight, easy to use, and integrates seamlessly with your projects.

Installation

As of this time, Utils CLI only be built from source

git clone https://github.com/opeolluwa/utils.git
cd utils
cargo build --release
cargo install --path .

Executing program

To run the application locally

cargo run -- --help

Usage

utils <COMMAND>

Commands

  • store: Store and retrieve data as key-value pairs.
utils store --key=<KEY> --value=<Value> --secure
  • ignore: Generate a .gitignore file for your project tooling.
utils ignore --lang=<tool-name>
  • readme: Add a README.md to your project.
utils readme <project-name>
  • upgrade: Upgrade the CLI tool to the latest version.
utils upgrade
  • sync: Synchronize the data with a remote database.
utils sync --database-url=<REMOTE_DATABASE_CONNECTION>
  • config: Configure CLI behavior using a config file at $HOME/.utils/utils.conf
utils config | vi
  • help: Display the help message for available commands.
utils help

Options

The basic usage of Utils CLI involves passing a command followed by optional arguments.

License

This project is licensed under the Apache License Version 2.0 License - see the LICENSE file for details