Skip to content

docs: add @floelabs/cli to the onboarding table, disambiguate the two… - #46

Merged
shivamfloe merged 1 commit into
mainfrom
docs/floelabs-cli
Aug 6, 2026
Merged

docs: add @floelabs/cli to the onboarding table, disambiguate the two…#46
shivamfloe merged 1 commit into
mainfrom
docs/floelabs-cli

Conversation

@rajbhensdadiya

@rajbhensdadiya rajbhensdadiya commented Aug 6, 2026

Copy link
Copy Markdown
Member

… CLIs, refresh supported versions

Summary by CodeRabbit

  • Documentation
    • Clarified installation options by distinguishing the Platform CLI, NPM SDK, and interactive AgentKit CLI.
    • Updated CLI command descriptions to reduce confusion between standalone tools.
    • Removed outdated information about free credits.
    • Refreshed supported-version information for AgentKit, MCP Server, Platform CLI, and related actions.

@rajbhensdadiya rajbhensdadiya self-assigned this Aug 6, 2026
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The README now distinguishes the SDK, AgentKit CLI, and Platform CLI. SECURITY.md adds the Platform CLI and updates supported versions for AgentKit actions and the MCP Server.

Changes

Documentation and support updates

Layer / File(s) Summary
CLI guidance and supported versions
README.md, SECURITY.md
The README identifies the floe-agent and @floelabs/cli commands. SECURITY.md adds the Platform CLI and updates supported version ranges.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: shibbyy, achris7

Poem

A rabbit hops through docs so bright,
“floe-agent” guides the CLI right.
Versions bloom in rows anew,
Security notes their ranges too.
Hop, hop—clear paths in view!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main documentation changes: adding @floelabs/cli and distinguishing the two CLIs.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/floelabs-cli

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@SECURITY.md`:
- Around line 25-28: Update the supported-version table by removing or merging
the nonexistent `@floelabs/cli` entry into the floe-agent npm entry, using version
0.6.0, and change the MCP Server entry from `@floelabs/mcp-server` 0.3.x to the
supported public 0.2.0 release or its documented version policy.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 88e73f63-80b7-4cc3-8c94-bd2fdb6a9ce3

📥 Commits

Reviewing files that changed from the base of the PR and between 2ce597f and 2ad865e.

📒 Files selected for processing (2)
  • README.md
  • SECURITY.md

Comment thread SECURITY.md
@shivamfloe
shivamfloe merged commit 7f4c978 into main Aug 6, 2026
4 checks passed
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