gopher-cli-manager

module
v0.0.0-...-24cf644 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2024 License: GPL-3.0

README ยถ

Gopher CLI Manager ๐Ÿน๐Ÿ’ป

Gopher CLI Manager is a terminal user interface (TUI) application for managing Command-Line Interface (CLI) tools. It allows you to easily add, update, search, and remove CLI tools stored in a SQLite database. Built with Go, this project leverages bubbletea for the interactive UI and sqlite3 for the database management. ๐Ÿš€

Features โœจ

  • ๐Ÿ“‹ View all CLI tools: List all stored CLI tools.
  • ๐Ÿ” Search for CLIs: Search for CLI tools by name or description.
  • โž• Add new CLIs: Easily add a new CLI with name, description, and path.
  • โœ๏ธ Edit existing CLIs: Update the information for an existing CLI.
  • ๐Ÿ—‘๏ธ Delete CLIs: Remove CLI tools from the database.

Screenshot ๐Ÿ“ธ

App Screenshot
Add a screenshot of your TUI application here

Installation ๐Ÿ› ๏ธ

  1. Clone the repository:
    git clone https://github.com/yourusername/gopher-cli-manager.git
    
  2. Navigate into the project directory:
    cd gopher-cli-manager
    
  3. Install dependencies:
    go mod tidy
    
  4. Build the project:
    make build
    

Usage ๐Ÿš€

After building the project, you can run it using:

make run
CLI Management Options
  • Press v to view all CLI tools.
  • Press s to search for CLI tools.
  • Press a to add a new CLI tool.
  • Press q to quit the program.

Database Schema ๐Ÿ—„๏ธ

The SQLite database contains a single table called cli with the following columns:

  • id: Unique identifier (INTEGER, PRIMARY KEY, AUTOINCREMENT)
  • name: The name of the CLI tool (TEXT)
  • description: A brief description of the CLI tool (TEXT)
  • path: The path to the CLI tool (TEXT)

Contributing ๐Ÿค

Feel free to open issues or submit pull requests! Contributions are welcome.

License ๐Ÿ“„

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

Future Enhancements ๐Ÿ”ฎ

  • Add more fields to the CLI database (e.g., version, category).
  • Implement a command-line argument interface for advanced usage.
  • Support for additional database options (e.g., PostgreSQL, MySQL).

Credits ๐Ÿ’ก

  • Charm for the bubbletea framework.
  • Mattn for the SQLite Go driver.

Project Logo

Directories ยถ

Path Synopsis
internal
tui
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL