QQ CLI

QQ CLI is a versatile command-line interface tool designed as a Proof of Concept to automate and simplify tasks in development environments. This first version primarily focuses on Ruby on Rails, Node.js & Rust projects. By intelligently detecting the project type can execute a set of basic commands.

Features

• Focused on Ruby on Rails, Node.js, Middleman & Rust: Tailored to handle common tasks in Rails, Node.js, Middleman and Rust projects.
• Intelligent Project Detection: Automatically identifies the type of project and executes relevant commands.
• Basic Command Set: Supports basic commands like installation, migration, starting servers, and running tests for Rails & Rust projects.
• Proof of Concept: Demonstrates the potential for a more extensive tool with broader capabilities in future versions.

Version 0.1.1

This initial version includes basic functionalities for Rails, Node.js, Middleman and Rust projects:

• Detection of project type.
• Execution of basic commands:
  • install (or i): Installs dependencies.
  • migrate (or m): Runs database migrations for Rails projects.
  • start (or s): Starts the project server.
  • test (or t): Runs the test suite for Rails projects (Minitest or Rspec), Node.js & Rust.
  • routes (or r): Show routes for Rails projects (uses fzf if available).

Future Development

Enhancing Functionality and User Experience

• Dynamic Command Execution: Future versions aim to enhance command execution based on context, allowing for more intelligent and adaptive interactions depending on the project environment and user preferences.

• Configuration File Support: To increase flexibility, I plan to implement support for configuration files. This will allow users to customize the behavior according to their specific needs, making the tool more versatile and personalized.

• Extensibility and Modularity: A key goal is to design QQ CLI with extensibility and modularity in mind. This would enable easy integration of new languages, frameworks, and features, fostering a tool that evolves alongside the ever-changing landscape of software development.

Installation

1. Clone the repository:

git clone https://github.com/moviendome/qq_cli.git

2. Navigate the project directory:

cd qq_cli

3. Build the project (requires Rust and Cargo):

cargo build --release

4. (Optional) Add the binary to your PATH for easy access:

sudo cp target/release/qq /usr/local/bin

Usage

Run QQ CLI from the command line within your project directory:

qq [command]

Example for installing dependencies for you project:

qq install

For more information on each command, use:

qq --help

Contributing

Contributions are welcome! If you have a feature request, bug report, or a pull request, please feel free to contribute.

Fork the repository and create your branch from main. Make your changes and test them. Send a pull request with a clear description of your changes.

License

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