docs: Add organization management guide for CLI org commands#5353
Open
iris-clawd wants to merge 1 commit intomainfrom
Open
docs: Add organization management guide for CLI org commands#5353iris-clawd wants to merge 1 commit intomainfrom
iris-clawd wants to merge 1 commit intomainfrom
Conversation
Add documentation for managing organizations via the CrewAI CLI: - crewai login (and how it sets the active org) - crewai org list - crewai org switch <org_id> - crewai org current Includes a practical example for verifying the active org before publishing tools, and adds a tip to the Tool Repository guide linking to the new page. Closes common confusion when users belong to multiple orgs and publish tools to the wrong organization.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation for managing organizations via the CrewAI CLI, covering:
crewai login— how authentication sets the active organizationcrewai org list— listing all orgs a user belongs tocrewai org current— checking which org is currently activecrewai org switch <org_id>— switching to a different orgMotivation
Users who belong to multiple organizations (e.g., a personal org and a team org) may inadvertently publish tools or create deployments in the wrong organization. After running
crewai login, the CLI sets the active org to the server default, which may not be the intended target org.This guide makes the org management workflow explicit so users know to verify and switch their active org before performing org-scoped actions like
crewai tool publishorcrewai deploy create.Changes
docs/en/enterprise/guides/organization-management.mdx— full guide with command reference, practical step-by-step example, and explanation of how settings are storeddocs/en/enterprise/guides/tool-repository.mdx— added a tip to verify the active org before publishingdocs/docs.json— added the new page to the Enterprise > How-To Guides navigationNote
Low Risk
Documentation-only changes that add a new guide and navigation link; risk is limited to potential broken doc links or navigation ordering issues.
Overview
Adds a new Enterprise guide,
organization-management.mdx, documenting CLI organization workflows (crewai org current|list|switch) and howcrewai loginsets the active org, including a step-by-step publishing example.Updates the Enterprise docs nav (
docs.json) to include the new page and adds a tip intool-repository.mdxpointing users to verify/switch org before publishing tools.Reviewed by Cursor Bugbot for commit cf49dd4. Bugbot is set up for automated code reviews on this repo. Configure here.