docs: add praisonai init page + update agent/command/custom-agents pages#815
Conversation
…ges (fixes #809) - Rewrites docs/cli/init.mdx for the new `praisonai init` scaffold subcommand (replaces old --init flag content): hero diagram, Quick Start Steps, How It Works sequence diagram, project-vs-global decision diagram, Flags table, Scaffolded files, Common Patterns, Best Practices AccordionGroup, Related CardGroup - Adds <Note> callout + Step 0 `praisonai init` + Init card to docs/features/custom-agents-commands.mdx - Adds <Tip> callout + Init card to docs/cli/agent.mdx - Adds <Tip> callout + Init card to docs/cli/command.mdx - Moves docs/cli/init to top of Core Commands group in docs.json Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
|
Warning Review limit reached
More reviews will be available in 16 minutes and 3 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to reflect the new praisonai init command, which scaffolds a .praisonai/ project directory containing configuration, a starter agent, and a starter command. This replaces the older --init flag documentation. The review comments correctly point out inconsistencies in the documented CLI commands (e.g., using praisonai agent run and praisonai command run instead of the standard praisonai run --agent and praisonai run --command syntax).
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| <Step title="Run the scaffolded agent"> | ||
|
|
||
| ```bash | ||
| praisonai --init [topic] [options] | ||
| praisonai agent run assistant "hello" | ||
| ``` | ||
|
|
||
| ## Options | ||
| </Step> | ||
|
|
||
| | Option | Description | | ||
| |--------|-------------| | ||
| | `--init` | Initialize agents with optional topic | | ||
| | `--framework` | Framework to use (crewai, autogen, praisonai) | | ||
| | `--merge` | Merge with existing agents.yaml | | ||
| <Step title="Run the scaffolded command"> | ||
|
|
||
| ## Intelligent Tool Discovery | ||
| ```bash | ||
| praisonai command run review "src/foo.py" | ||
| ``` | ||
|
|
||
| The init command analyzes your task and automatically assigns tools from 9 categories: | ||
| </Step> |
There was a problem hiding this comment.
The commands praisonai agent run and praisonai command run are inconsistent with the rest of the documentation. According to docs/cli/agent.mdx, docs/cli/command.mdx, and docs/features/custom-agents-commands.mdx, the correct commands to execute custom agents and commands are praisonai run --agent <name> and praisonai run --command <name>.\n\nPlease update these steps to use the consistent syntax:\n\nbash\npraisonai run --agent assistant "hello"\n\n\nand\n\nbash\npraisonai run --command review "src/foo.py"\n
| | Resolve target | Walks up to the git root (or uses cwd) and sets `.praisonai/` as the base | | ||
| | Write files | Creates `config.yaml`, `agents/assistant.md`, `commands/review.md` | | ||
| | Report | Prints `Created <path>` or `Skipped (already exists, use --force): <path>` per file | | ||
| | Next steps | Prints the exact `agent run` and `command run` commands you can copy | |
There was a problem hiding this comment.
The description mentions agent run and command run commands, which are inconsistent with the standard run --agent and run --command syntax used elsewhere in the documentation.\n\nPlease update this description to match the standard syntax:\nPrints the exact run --agent and run --command commands you can copy
| ```bash | ||
| praisonai --init "Scrape websites for product data and save to CSV" | ||
| praisonai init | ||
| praisonai agent run assistant "hello" |
There was a problem hiding this comment.
The command praisonai agent run assistant "hello" is inconsistent with the standard praisonai run --agent assistant "hello" syntax.\n\nPlease update this to:\nbash\npraisonai run --agent assistant "hello"\n
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
1 participant
Summary
docs/cli/init.mdxfor the newpraisonai initscaffold subcommand (replaces old--initflag content): hero diagram, Quick Start Steps, How It Works sequence diagram, project-vs-global decision diagram, Flags table, Scaffolded files, Common Patterns, Best Practices AccordionGroup, Related CardGroup<Note>callout + Step 0praisonai init+ Init card todocs/features/custom-agents-commands.mdx<Tip>callout + Init card todocs/cli/agent.mdx<Tip>callout + Init card todocs/cli/command.mdxdocs/cli/initto top of Core Commands group indocs.jsonFixes #809
Generated with Claude Code