CLI Index CLI Index
← All Posts

How to Submit a CLI Tool to This Directory

· 1 min read
contributingguide

Contributing a New Tool

CLI Index is open to contributions. If you know a CLI tool that works well with AI agents, you can add it by creating a markdown file with the proper frontmatter.

Step-by-Step Process

1. Create the Markdown Files

Add a markdown file under both language directories:

  • src/content/clis/en/<slug>.md — English version
  • src/content/clis/zh-hans/<slug>.md — Chinese version

Both files must have the same filename. The build does not enforce pairing, so a missing file in either language will silently result in that tool being absent from that language version.

2. Required Frontmatter

Every CLI entry requires these fields:

  • name — Display name of the tool
  • tag — One of: recommended, builtin, official, community, download
  • description — Short one-line description
  • agentSupport — Rating from 1 to 5
  • category — Must match an id in categories.json
  • binary — The command name (e.g., gh, ffmpeg)
  • homepage — URL to the tool’s homepage
  • agentExample — Example command showing typical agent usage

3. Optional Fields

  • version — Current version string
  • platforms — Array of macos, linux, windows
  • repository — GitHub or source code URL
  • install — Object with package manager names as keys and commands as values
  • auth — One of: none, api-key, oauth, login
  • mcpEquivalent — Boolean, whether an MCP server exists
  • featured — Boolean, whether to show in the Featured section

4. Write the Body Content

The markdown body should describe the tool in 2-3 paragraphs, focusing on its capabilities relevant to AI agents.

5. Validate

Run npm run build — this is the project’s sole quality gate. It runs Zod schema validation on every content file and will catch any missing or invalid fields.

Related Posts