ORCHESTRA MCP
Orchestra MCP
Pages · Orchestra MCP

Contributing to cli

Prerequisites

  • Go 1.23+
  • gofmt, go vet

Development Setup

bash

Building

bash

Testing

bash

Code Organization

text

Adding a New IDE

  1. Add a new function in internal/ide.go that returns an *IDEConfig.
  2. Register it in the ideRegistry map.
  3. Add it to the allIDENames() slice.
  4. Update the --ide flag description in initcmd.go and main.go.
  5. Update docs/COMMANDS.md.

Adding a New Command

  1. Create a new file in internal/ (e.g., mycommand.go) with a RunMyCommand(args []string) function.
  2. Add the case to the switch in main.go.
  3. Update the printUsage() function.
  4. Update docs/COMMANDS.md.

Code Style

  • Run gofmt on all files.
  • Run go vet ./... before committing.
  • All exported functions and types must have doc comments.
  • Error output goes to stderr (fmt.Fprintf(os.Stderr, ...)).
  • The fatal() helper prints to stderr and exits with code 1.
  • Subcommands use flag.NewFlagSet for independent flag parsing.

Pull Request Process

  1. Fork the repository and create a feature branch from main.
  2. Write or update tests for your changes.
  3. Run go test ./... and go vet ./....
  4. Update docs/COMMANDS.md if adding or changing commands.
  5. Update docs/PLUGIN_DEVELOPMENT.md if changing the plugin install flow.