QuickRef

QuickRef is a terminal-first CLI application designed to be your personal command reference and learning tool.

Built for users learning Linux, networking, Git, and cybersecurity, QuickRef helps you quickly recall the purpose, syntax, and options of commands without ever having to leave your terminal or open a browser.

Philosophy: FAST → CLEAR → PRACTICAL → LEARN

Features

• Fast Lookups: quickref chmod gives you an immediate, concise, and useful explanation of the command.
• Search Capabilities: Forget the command name? Use quickref search "permissions" to find what you're looking for.
• Clean Formatting: Designed for readability with clear sections for USAGE, EXAMPLES, RELATED commands, and TIPS.
• Fully Offline: All data is stored locally. No web frontend, no cloud service, no AI latency. Just fast access to a structured knowledge base.

Installation

QuickRef is built in Python and can be easily installed locally using pip.

1. Clone the repository:

   git clone https://github.com/husainhakim/QuickRef.git
   cd QuickRef

2. Install the package locally:

   # This will install QuickRef so it's available globally in your terminal
   pip install -e .

   (Note: Depending on your Python setup, you may need to use pip3 instead of pip)

3. Verify installation:

   quickref --help

Usage & Examples

Lookup a specific command:

quickref chmod

View just the examples:

quickref chmod --example

View related commands:

quickref chmod --related

Search for a concept:

quickref search "permissions"

List commands by category:

quickref list "Linux"

Adding Custom Commands

QuickRef is designed to grow with your knowledge. To add your own commands, simply edit the quickref/data/commands.json file. The application will automatically pick up your changes!

See SUPPORTED_COMMANDS.md for a list of what's currently included.

Future Roadmap

QuickRef is actively evolving. Here are some features planned for the future:

• Interactive Quizzes (--quiz): A built-in feature to test your knowledge! Running quickref chmod --quiz will hide the syntax and prompt you with a scenario (e.g., "Make this file executable"), requiring you to type the correct command to help commit it to muscle memory.
• Usage Statistics: Track which commands you search for the most so you know where you need the most practice.
• Personal Notes: The ability to attach your own custom notes, gotchas, or cheat codes to specific commands directly from the terminal.