Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hopx.ai/llms.txt

Use this file to discover all available pages before exploring further.

Manage organization settings using the org command. View organization information, update settings, list organizations, and switch between organizations.

​
Command Syntax

hopx org <subcommand> [options]

​
Subcommands

​
info

Get organization information. Syntax: 
hopx org info [OPTIONS]
Examples: 
# Get organization info
hopx org info
Expected Output: 
┌─────────────┬─────────────────────────────────────┐
│ Property    │ Value                               │
├─────────────┼─────────────────────────────────────┤
│ Name        │ My Organization                     │
│ ID          │ org_abc123                          │
│ Plan        │ Pro                                 │
│ Members     │ 5                                   │
└─────────────┴─────────────────────────────────────┘
Exit Codes:
  • 0 - Success
  • 3 - Authentication error

​
update

Update organization settings. Syntax: 
hopx org update [OPTIONS]
Options:
  • --name TEXT - Organization name
Examples: 
# Update organization name
hopx org update --name "New Organization Name"
Expected Output: 
✓ Organization updated
Exit Codes:
  • 0 - Success
  • 3 - Authentication error

​
list

List all organizations you belong to. Syntax: 
hopx org list [OPTIONS]
Examples: 
# List organizations
hopx org list
Expected Output: 
┌──────────────┬──────────────────────┐
│ Name         │ Role                 │
├──────────────┼──────────────────────┤
│ My Org       │ owner                 │
│ Team Org     │ member                │
└──────────────┴──────────────────────┘
Exit Codes:
  • 0 - Success
  • 3 - Authentication error

​
switch

Switch to a different organization. Syntax: 
hopx org switch ORGANIZATION_ID [OPTIONS]
Arguments:
  • ORGANIZATION_ID - Organization ID (required)
Examples: 
# Switch organization
hopx org switch org_abc123
Expected Output: 
✓ Switched to organization: My Organization
Exit Codes:
  • 0 - Success
  • 3 - Authentication error
  • 4 - Organization not found

​
Next Steps