Document npm CLI getting started

[fakechris]

Summary

• make npm CLI installation the fastest getting-started path
• keep local compose as the self-hosted stack quick start
• document npm CLI import usage alongside compose CLI usage

Validation

• docs-only change
• verified @turnkeyai/involute@0.1.4 installs and involute --help runs from a clean directory

---

[coderabbitai]

Warning

Rate limit exceeded

@fakechris has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 49 minutes and 14 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 49 minutes and 14 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5422bc58-5be2-4271-a740-ccd17c007271

📥 Commits

Reviewing files that changed from the base of the PR and between feb962d and 2baba9a.

📒 Files selected for processing (1)

• README.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/npm-getting-started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

[gemini-code-assist]

Code Review

This pull request updates the README.md to include instructions for installing and using the published CLI, alongside the existing local development setup. The documentation now covers global and local npm installations, CLI configuration, and team imports. Feedback was provided to clarify the use of npx for local installations and to specify the DATABASE_URL requirement for the team import command.

[gemini-code-assist]

Since both global and local installation methods are shown, it's helpful to clarify that the subsequent examples assume a global installation. Users who chose the local path will need to use npx involute instead of just involute.

Suggested change

	Point the CLI at your Involute API:
	Point the CLI at your Involute API (use `npx involute` if installed locally):

[gemini-code-assist]

The involute import team command requires the DATABASE_URL environment variable to be set, as it connects directly to the database via Prisma. This is not required for the API-based commands like teams list. Explicitly mentioning this requirement prevents users from encountering connection errors when following this 'fastest' path.

Suggested change

	Import and verify one team snapshot:
	Import and verify one team snapshot (requires `DATABASE_URL` to be set):