Skip to content

docs: expand command reference and add shell completions#1

Merged
Yukaii merged 1 commit into
mainfrom
cursor/readme-and-shell-completions
May 26, 2026
Merged

docs: expand command reference and add shell completions#1
Yukaii merged 1 commit into
mainfrom
cursor/readme-and-shell-completions

Conversation

@Yukaii
Copy link
Copy Markdown
Member

@Yukaii Yukaii commented May 26, 2026

Summary

  • Expand README with a detailed command reference, examples, global options, and configuration notes
  • Register Cliffy CompletionsCommand and document bash/zsh/fish setup

Test plan

  • bun test
  • codimd-cli --help and codimd-cli <command> --help render as expected
  • codimd-cli completions bash|zsh|fish emit completion scripts
  • README examples match current CLI behavior

Made with Cursor

Improve README usage docs and register Cliffy's completions subcommand for bash, zsh, and fish setup.

Co-authored-by: Cursor <cursoragent@cursor.com>
@Yukaii Yukaii marked this pull request as ready for review May 26, 2026 19:19
@Yukaii Yukaii merged commit 02c8791 into main May 26, 2026
2 checks passed
@Yukaii Yukaii deleted the cursor/readme-and-shell-completions branch May 26, 2026 19:21
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.

1 participant