Skip to main content

A cli helper tool that helps with day to day cli commands and automates software development

Project description

CLI Helper Tool

A CLI helper tool that helps with day-to-day commands and automates software development tasks. This tool provides configuration management and a CLI-friendly cyborg tool for other tasks.

Installation

To install this tool via pip, run:

pip install cli

Alternatively, if you are using Poetry, run:

poetry install

Usage

After installing the package, you can access the command line tool using the pilot command.

Commands

This tool provides the following commands:

config - Configuration options

The config command allows you to manage configuration key-value pairs.

Subcommands

  • create: Set a configuration key-value pair.

    Usage:

    pilot config create <key=value>
    

    Example:

    pilot config create api_key=12345
    
  • read: Read a configuration value by key or print all key-value pairs.

    Usage:

    pilot config read <key>
    

    If the key is omitted, all key-value pairs will be displayed:

    pilot config read
    

    Example:

    pilot config read api_key
    
  • remove: Remove a configuration value by key.

    Usage:

    pilot config remove <key>
    

    Example:

    pilot config remove api_key
    

cyborg - A CLI friendly cyborg tool

The cyborg command provides a simple cyborg tool to run a specific CLI-friendly app.

Subcommands

  • run: Run the Cyborg app.

    Usage:

    pilot cyborg run
    

Example Usage

1. Set a configuration key-value pair:

pilot config create api_key=12345

2. Read a configuration key:

pilot config read api_key

3. Read all configuration key-value pairs:

pilot config read

4. Remove a configuration key:

pilot config remove api_key

5. Run the Cyborg app:

pilot cyborg run

Dependencies

This CLI tool relies on the following packages:

  • click
  • colorama
  • textual
  • ollama

You can manage and install the dependencies using Poetry or pip.

License

This project is licensed under the MIT License - see the LICENSE file for details.


Key Updates:

  1. Changed Command Name to pilot: Since your tool is published as cli but should be executed with the pilot command, I’ve updated all references of the command to pilot.
  2. Clarified Installation: Both pip and Poetry installation methods are included for flexibility.

This README should now correctly reflect your tool's installation and usage instructions with the proper command (pilot).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

retan-0.1.0.tar.gz (2.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

retan-0.1.0-py3-none-any.whl (2.6 kB view details)

Uploaded Python 3

File details

Details for the file retan-0.1.0.tar.gz.

File metadata

  • Download URL: retan-0.1.0.tar.gz
  • Upload date:
  • Size: 2.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.4 Windows/11

File hashes

Hashes for retan-0.1.0.tar.gz
Algorithm Hash digest
SHA256 15fec7ed12f1aeefc6017cbd99e42195b541ad11e6f339b2ea17cbbc23aca5b0
MD5 df9c0218c37b7ecc7328b7751f4d9f6b
BLAKE2b-256 158ab22f5f2ef42c97c7d193db9deda5316c94e47a50c1346fdebc29052effe1

See more details on using hashes here.

File details

Details for the file retan-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: retan-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.4 Windows/11

File hashes

Hashes for retan-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed32697b4952ec860387f1e205eff686e39b6acc2d00c88a0f9ad2ffbb8aeda1
MD5 362effc558e0987eb3348c9d4289cd24
BLAKE2b-256 314e27022b6f94970d83de5fe3e76edf092e142eda1ec395091c806975ec21b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page