⚙️ proCLI

ProCLI is a command-line tool designed to help developers manage and validate project prerequisites. It simplifies the setup and ensures consistency by checking for required tools, environment variables, tokens, and version control systems.

---

Features

• Initialize Project Configurations:

  • Use the init command to interactively create a project configuration file.
  • Supports specifying:
    • Required tools
    • Environment variables
    • Tokens
    • Version control systems

• Validate Project Setup:

  • Use the check command to validate if the system meets the project prerequisites.
  • Provides a clear, actionable output with success and failure indicators.

• Configuration Management:

  • Configuration files are stored locally in ~/.config/procli/config.yaml.
  • Supports multiple projects and a default project.

---

Installation

Prerequisites

• Go 1.20 or later installed.

Clone and Build

1. Clone the repository:

   git clone <repository-url>
   cd procli

2. Build the binary:

   go build -o procli

3. Install procli

   go install 

---

Usage

Initialize a Project

Run the init command to create a new project configuration:

procli init

Example interaction:

Enter project name: tensorflow
Enter required tools (comma-separated): clang-tidy, pylint, docker, bazel, python
Enter environment variables (comma-separated): INDIVIDUAL_CLA, CORPORATE_CLA
Enter required tokens (comma-separated): 
Enter version control system (e.g., git): git
Project configuration saved!

Validate a Project

Run the check command to validate project prerequisites:

procli check <project-name>

If a default project is configured, the project name can be omitted:

procli check

Example output:

---

Configuration File Structure

Configurations are stored as YAML in ~/.config/procli/config.yaml. Example structure:

default: tensorflow
projects:
  tensorflow:
    required_tools:
      - docker
      - python
    environment_vars:
      - INDIVIDUAL_CLA
      - CORPORATE_CLA
    required_tokens: []
    version_control: git

---

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature-name).
3. Commit your changes (git commit -m "Add feature").
4. Push to the branch (git push origin feature-name).
5. Open a Pull Request.

---

License

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

---

Roadmap

• Integrate a TUI (using Bubble Tea) for project initialization and editing.