Skip to content

improvement(cli): clarify npm package readmes - #7121

Merged
waleedlatif1 merged 1 commit into
stagingfrom
fix/cli-readme
Aug 26, 2026
Merged

improvement(cli): clarify npm package readmes#7121
waleedlatif1 merged 1 commit into
stagingfrom
fix/cli-readme

Conversation

@TheodoreSpeaks

Copy link
Copy Markdown
Collaborator

Summary

  • Rewrite the Sim CLI README around npm installation, login, profiles, useful commands, and automation
  • Expand the sim-setup README with prerequisites, lifecycle commands, capability setup, and data-safety guidance

Type of Change

  • Improvement

Testing

  • bun run lint
  • bun run apps/sim/scripts/check-block-registry.ts origin/staging
  • bun run check:audits
  • 66 Sim CLI profile and authentication tests
  • 7 sim-setup argument parser tests

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercel Bot commented Aug 26, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
docs Skipped Skipped Aug 26, 2026 8:01pm

Request Review

@greptile-apps

greptile-apps Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR rewrites the published npm package documentation for the Sim CLI and self-hosted setup utility.

  • Adds installation, authentication, profile, command, and automation guidance for sim.
  • Adds prerequisites, lifecycle operations, capability configuration, upgrade guidance, and data-safety documentation for sim-setup.

Confidence Score: 5/5

The documentation-only PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
packages/sim-cli/README.md Reorganizes the CLI documentation around installation, login, profiles, common commands, structured I/O, and automation.
packages/sim-setup/README.md Expands standalone setup documentation with requirements, installation management, capability setup, updates, persistence guidance, and production considerations.

Reviews (2): Last reviewed commit: "improvement(cli): clarify npm package re..." | Re-trigger Greptile

Comment thread packages/sim-cli/README.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 2 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Re-trigger cubic

@TheodoreSpeaks

Copy link
Copy Markdown
Collaborator Author

@greptile

@TheodoreSpeaks

Copy link
Copy Markdown
Collaborator Author

@cursor review

@cursor

cursor Bot commented Aug 26, 2026

Copy link
Copy Markdown

Skipping Bugbot: Bugbot is disabled for this repository. Visit the Bugbot dashboard to update your settings.

@waleedlatif1
waleedlatif1 merged commit b724cd1 into staging Aug 26, 2026
6 checks passed
@waleedlatif1
waleedlatif1 deleted the fix/cli-readme branch August 26, 2026 20:11
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