cli readme.md docs added

[afsar-dev]

Summary by CodeRabbit

• Documentation
  • Added a dedicated CLI README detailing usage of list and add commands, with examples, expected outputs, and a high-level add workflow overview. Improves clarity for getting started; no code changes.
• Style
  • Minor formatting cleanup in the main README (removed an extra blank line) for consistency; no functional impact.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project	Deployment	Preview	Comments	Updated (UTC)
nurui	✅ Ready	Preview	Comment	Aug 12, 2025 3:15pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation-only changes: a minor formatting tweak in the root README and the addition of a detailed README for the Nurui CLI describing list/add commands and the add workflow. No code or API surface changes.

Changes

Cohort / File(s)	Summary of Changes
Root README formatting README.md	Removed a single empty line between sponsor block and Maintainer section; content unchanged.
CLI documentation src/cli/README.md	Added comprehensive CLI docs covering list/add commands, usage examples, and end-to-end add flow (registry lookup, prompts, downloads, utils creation, optional TS→JS transpile, package manager detection, dependency installation, summary).

Sequence Diagram(s)

sequenceDiagram
  actor Dev as Developer
  participant CLI as Nurui CLI
  participant Reg as Component Registry
  participant FS as File System
  participant Trans as TS→JS Transpiler
  participant PM as Package Manager

  Dev->>CLI: npx nurui add <component-name>
  CLI->>Reg: Fetch components list
  Reg-->>CLI: Components metadata
  CLI->>CLI: Lookup selected component
  CLI->>Dev: Prompt for TS/JS and naming if needed
  CLI->>Reg: Download component files
  Reg-->>CLI: Files archive/content
  CLI->>FS: Create lib/utils (if missing)
  alt JS chosen and source is TS
    CLI->>Trans: Transpile TS→JS
    Trans-->>CLI: JS files
  end
  CLI->>CLI: Detect package manager
  CLI->>PM: Install dependencies
  PM-->>CLI: Install result
  CLI-->>Dev: Success summary

Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

• Add README documentation for CLI (usage & features) #20 — Adds CLI documentation for src/cli/README.md, matching this PR’s new CLI README content.

Poem

A twitch of whiskers, docs aligned,
I hop through READMEs, neat and kind.
A CLI tale, from list to add—
Fetch, transpile, install—so rad! 🥕
With tidy lines and guidance clear,
Ship it swift—then thump a cheer!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6ebe469 and bbdaf6d.

📒 Files selected for processing (2)

• README.md (0 hunks)
• src/cli/ README.md (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dev

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.