Contributing to Commands.app

Help us build the best command-line reference for developers

Ways to Contribute

1Add New Commands

Know a command that's missing? Add it to our database by editing data/commands.json

2Improve Documentation

Fix typos, improve descriptions, or add better examples to existing commands

3Add New Technologies

Suggest or add support for new CLI tools and frameworks

4Improve UI/UX

Enhance the user interface, add new features, or fix bugs

5Report Issues

Found incorrect information or a bug? Let us know!

Quick Start Guide

Follow these steps to contribute to Commands.app

Fork the Repository

Click the "Fork" button on our GitHub repository

https://github.com/sanampatel/commands.app

Clone Your Fork

Clone the repository to your local machine

git clone https://github.com/YOUR-USERNAME/commandsapp.git
cd commandsapp

Create a Branch

Create a new branch for your changes

git checkout -b add-new-command

Make Your Changes

Edit data/commands.json or other files. See the detailed guide for the data structure.

Test Your Changes

Run the development server and verify your changes

npm install
npm run dev

Commit and Push

Commit your changes with a clear message

git add .
git commit -m "Add docker compose commands"
git push origin add-new-command

Create Pull Request

Go to your fork on GitHub and click "New Pull Request". Provide a clear description of your changes.

Adding a Command

Commands are stored in data/commands.json. Here's the structure:

{
  "id": "docker-compose-up",
  "name": "docker compose up",
  "description": "Build and start containers defined in compose file",
  "category": "Container Management",
  "technologyId": "docker",
  "flags": [
    {
      "flag": "-d",
      "description": "Run in detached mode"
    }
  ],
  "examples": [
    {
      "command": "docker compose up -d",
      "description": "Start containers in background"
    }
  ],
  "notes": [
    "Reads docker-compose.yml by default"
  ],
  "relatedCommands": ["docker-compose-down"]
}

Contribution Guidelines

Be accurate: Ensure all commands, flags, and examples are correct and tested

Be clear: Write descriptions that are easy to understand for developers of all levels

Be concise: Keep descriptions brief but informative

Follow conventions: Match the style and format of existing commands

One change per PR: Keep pull requests focused on a single feature or fix

Resources

GitHub Repository →Detailed Contributing Guide →Issues & Bug Reports →Community Discussions →

Thank You! 🎉

Your contributions help developers around the world. We appreciate your time and effort!