Skip to content

docs: expand README to the full CLI user guide - #3

Merged
alibek-seksenali merged 1 commit into
mainfrom
docs/readme
Sep 11, 2026
Merged

docs: expand README to the full CLI user guide#3
alibek-seksenali merged 1 commit into
mainfrom
docs/readme

Conversation

@alibek-seksenali

Copy link
Copy Markdown
Contributor

Summary

  • Replace the stub README with a full user guide for @1msg/cli (1MSG-166): install, config/precedence, all command groups, output, exit codes, completion, and the 61-operation map.
  • Bump to 0.1.3 so npm publishes the new README (files includes README.md).
  • --help remains the flag contract; this README is the GitHub/npm page, not a dump of every help snapshot.

Test plan

  • npm test (95 passed, 2 skipped monorepo-only)
  • README operation table matches OPERATION_COMMANDS (61 + deleteMediaLegacy)
  • CI green on this PR
  • After merge: GitHub release v0.1.3 + 1msg-api Publish @1msg/cli (dry_run=false)
  • npx -y @1msg/cli@0.1.3 version and npm README shows the new guide

Made with Cursor

Public GitHub/npm page now covers install, config, commands, output,
errors, completion, and the 61-operation map. Bump to 0.1.3 so npm
picks up the README.

Co-authored-by: Cursor <cursoragent@cursor.com>
@alibek-seksenali
alibek-seksenali merged commit c9d2a55 into main Sep 11, 2026
1 check passed
@alibek-seksenali
alibek-seksenali deleted the docs/readme branch September 11, 2026 15:03
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