Skip to content

feat: add command examples#2

Merged
Patrik Simek (patriksimek) merged 1 commit intomainfrom
feat-command-examples
Apr 17, 2026
Merged

feat: add command examples#2
Patrik Simek (patriksimek) merged 1 commit intomainfrom
feat-command-examples

Conversation

@patriksimek
Copy link
Copy Markdown
Member

Add examples to commands.

Copilot AI review requested due to automatic review settings April 17, 2026 10:06
@patriksimek Patrik Simek (patriksimek) requested a review from a team as a code owner April 17, 2026 10:06
@patriksimek Patrik Simek (patriksimek) merged commit 72f02c1 into main Apr 17, 2026
6 checks passed
@patriksimek Patrik Simek (patriksimek) deleted the feat-command-examples branch April 17, 2026 10:07
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds generated example command strings to CLI help output and introduces a docs generator that renders command reference markdown from MCP tool metadata.

Changes:

  • Introduces src/examples.ts helpers to format example values and assemble single-/multi-line shell commands.
  • Shows an “Example” section in command help output when a tool provides examples.
  • Adds scripts/build-docs.ts and npm run build:docs to generate docs/*.md reference pages.

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
test/examples.spec.ts Adds unit tests for example formatting and wrapping behavior.
test/commands.spec.ts Updates camelToKebab import source and adjusts help-group casing expectation.
src/examples.ts New example/value formatting utilities used by CLI help/docs.
src/commands.ts Integrates example formatting into per-command help text and imports shared helpers.
src/categories.ts Updates category titles/group labels to sentence-style casing.
scripts/build-docs.ts New docs generator that renders option tables and examples from MCP tools.
package.json Bumps version, adds build:docs, updates SDK dependency.
package-lock.json Lockfile updates for version/dependency changes.
README.md Adds an npx @makehq/cli ... usage example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/examples.ts
Comment thread test/examples.spec.ts
Comment thread scripts/build-docs.ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants