docs: improve CLI npm readme

[luanvdw]

Summary

• Replaces the npm-facing CLI README with beta-ready package docs
• Updates the root README command/package references to match the beta CLI direction
• Tightens the package description used in the staged npm manifest

Validation

• pnpm --filter @prisma/cli exec vitest run tests/publish-prep.test.ts

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1db59170-9092-40bc-9561-957c69a78b80

📥 Commits

Reviewing files that changed from the base of the PR and between 31a41f6 and b696303.

📒 Files selected for processing (4)

• README.md
• packages/cli/README.md
• packages/cli/package.json
• packages/cli/tests/publish-prep.test.ts

---

Summary by CodeRabbit

• Documentation

  • Expanded CLI README with comprehensive command reference, including new command examples and structured command-group table
  • Enhanced quickstart section with installation guidance and practical CLI command examples
  • Added project badges and clearer introduction describing CLI functionality
  • Updated documentation structure with Common examples and automation guidance

• Updates

  • Updated package description to clarify CLI's role in Prisma Developer Platform management

Walkthrough

Documentation and metadata for the Prisma CLI package are updated: the main README reflects unified CLI commands including project env list, the CLI package README is reorganized with new structure, badges, expanded examples and command documentation, package.json description is updated, and test fixtures are aligned with the new description.

Changes

CLI Documentation and Metadata Alignment

Layer / File(s)	Summary
Main README command and documentation updates README.md	The example workflow uses the new project env list --role preview command, the command-group list includes git, and documentation clarifies that the CLI package README is at packages/cli/README.md and is copied into the staged publish artifact.
CLI package README comprehensive reorganization packages/cli/README.md	The README is restructured with a centered header, badges, and refreshed description; Quickstart section expanded with installation and command examples; new Commands section added with command-group table and "Built for humans, CI, and agents" usage patterns; Beta notes clarified with Node.js 20+ requirement and .prisma/local.json caching; Documentation, Support, and License sections expanded.
Package description and test fixture alignment packages/cli/package.json, packages/cli/tests/publish-prep.test.ts	Package description is updated to "Command-line interface for the Prisma Developer Platform.", and all four test fixtures validating package staging are updated to match the new description string.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: improve CLI npm readme' directly summarizes the main change: improving the npm-facing CLI README documentation.
Description check	✅ Passed	The description is related to the changeset, outlining the three main changes: README replacement, root README updates, and package description tightening.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/cli-npm-readme

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch feat/cli-npm-readme

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.

---

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.}