Categorygithub.com/Thiti-Dev/ksc
module
1.0.1-osx
Repository: https://github.com/thiti-dev/ksc.git
Documentation: pkg.go.dev

# README

KSC (Known Shell Commands) šŸš€

KSC is a Terminal User Interface (TUI) executable written in Go, designed to manage and execute frequently used shell commands efficiently. It allows users to store, search, and execute commands, including those with arguments, through an intuitive and interactive interface. šŸ–„ļøāœØ

Features 🌟

  • Command Storage: Add and manage frequently used shell commands. šŸ“¦
  • Search Functionality: Quickly find stored commands using a search interface. šŸ”
  • Argument Placeholders: Store commands with placeholders (e.g., ping <address>) and prompt for arguments before execution. šŸ“āž”ļøšŸ”§
  • Interactive UI: Beautiful and user-friendly terminal interface for seamless command management and execution. šŸ–¼ļøšŸŽØ

Installation šŸ› ļø

  1. Clone the repository:

    git clone https://github.com/Thiti-Dev/ksc.git
    cd ksc
    

    šŸ“‚šŸ“„

  2. Install dependencies:

    go mod tidy
    

    šŸ“¦šŸ“‹

  3. Build the executable:

    go build -o ksc ./cmd/cli/*
    

    šŸ—ļøšŸš€

Usage šŸš€

Adding Commands āž•

You can add commands to KSC, which can include placeholders for arguments. šŸ“

Example:

ksc add "ping <address>" "ping to specific address"

✨

Searching and Selecting Commands šŸ”

When you start KSC, you will see a list of added commands. Use the search functionality to filter through the list. šŸ”Ž

ksc

šŸ“œ

Executing Commands with Arguments šŸ› ļø

If a command includes placeholders, KSC will prompt you to fill in the required arguments before execution. šŸ“āž”ļø

Example:

  1. Start KSC:

    ksc
    

    ā–¶ļø

  2. Search and select the command ping <address>. šŸ”šŸ“

  3. Enter the required argument when prompted:

    Enter value for <address>: 8.8.8.8
    

    šŸ–Šļøāž”ļø

KSC will then execute the command ping 8.8.8.8. šŸšŸš€

Example

Below is an example session using KSC: šŸŽ¬

# Add a command with an argument placeholder
ksc add "ping <address>" "ping to specific address"

# Start KSC
ksc

# Search and select the command
# (User types "ping" in the search box and selects "ping <address>")

# Prompt for the argument value
Enter value for <address>: 8.8.8.8

# Command is executed: ping 8.8.8.8

šŸŽ‰šŸŽ‰šŸŽ‰

Contributions šŸ¤

Contributions are welcome! Please feel free to submit a Pull Request or open an issue. šŸ™āœØ

License šŸ“œ

This project is licensed under the MIT License. See the LICENSE file for details. šŸ“„


With KSC, managing and executing your frequently used shell commands has never been easier. Enjoy a seamless and interactive experience right from your terminal! šŸš€šŸ’»šŸŽ‰


# Packages

No description provided by the author