Publishing Tools

Share your tools with the community by publishing to the CmdForge Registry.

Before Publishing

Make sure your tool has:

• A descriptive name and description
• A proper version (semver format: 1.0.0)
• A README.md file with usage examples
• Tested and working functionality

Create an Account

Register at the registry to get your publisher namespace.

Connect Your Account

Link your CLI or GUI to your registry account with a simple pairing flow:

Option 1: From the Command Line

# Start the connection flow
cmdforge config connect yourusername

This opens your browser to approve the connection. Once approved, you're ready to publish!

Option 2: From the Desktop GUI

1. Launch cmdforge (the desktop app)
2. Go to the Registry page
3. Click the Connect button
4. Enter your username and approve in the browser

Publish Your Tool

# Publish from CLI
cmdforge registry publish mytool

# Dry run to validate without publishing
cmdforge registry publish mytool --dry-run

# Check your published tools
cmdforge registry my-tools

Or use the desktop GUI:

1. Open the My Tools page
2. Right-click on your tool and select Publish
3. Confirm the version and publish

Moderation Process

Submitted tools go through a brief moderation review to ensure quality:

• Pending - Your tool is in the queue for review
• Approved - Your tool is live in the registry
• Changes Requested - A moderator has feedback for you

Check your moderation status anytime:

# See status of your submissions
cmdforge registry status

# Sync moderator feedback to your local tool
cmdforge registry status --sync

Versioning

Published versions are immutable. To update a tool:

1. Make your changes
2. Bump the version in config.yaml
3. Run cmdforge registry publish mytool

Best Practices

• Clear names - Use descriptive, lowercase names with hyphens
• Good descriptions - Explain what the tool does in one sentence
• Document arguments - Describe each flag in the help text
• Include examples - Show real usage in your README
• Choose the right category - Help users discover your tool
• Respond to feedback - If changes are requested, address them promptly