Skip to content

feat(cli): update clara-companion command naming and add local/cloud selection#237

Open
esc247 wants to merge 3 commits intoclaraverse-space:mainfrom
esc247:main
Open

feat(cli): update clara-companion command naming and add local/cloud selection#237
esc247 wants to merge 3 commits intoclaraverse-space:mainfrom
esc247:main

Conversation

@esc247
Copy link
Copy Markdown
Contributor

@esc247 esc247 commented Mar 28, 2026

What Changed

This PR introduces two key improvements to the clara-companion CLI tool:

  1. Local vs Cloud Authentication Selection

    • Users can now choose their authentication target when running clara-companion login
    • Options provided:
      • [1] Local Installation (localhost:3000) - For self-hosted deployments
      • [2] ClaraVerse Cloud (https://claraverse.app) - For cloud users
      • [3] Custom URL - For advanced configurations
  2. Consistent Command Naming

    • Changed command name from clara_companion to clara-companion throughout the codebase
    • Updated all user-facing messages, help text, and documentation

Why This Matters

  • Self-hosted users can now easily configure the companion for their local installations without manual URL editing
  • Consistent naming improves user experience and reduces confusion between the CLI tool name and internal references
  • Better UX with clear, guided authentication flow

How to Test

  1. Build the CLI:

    cd backend/mcp-bridge
    go build -o clara-companion ./cmd/clara_companion
  2. Run login command:

    ./clara-companion login
  3. Verify the selection prompt appears:

    Server Connection
    
    Select authentication target:
    
    [1] Local Installation (localhost:3000)
    [2] ClaraVerse Cloud (https://claraverse.app)
    [3] Custom URL
    
    Choose (1/2/3) [1]:
    
  4. Test each option:

    • Option 1 should configure ws://localhost:3000
    • Option 2 should configure wss://api.claraverse.app
    • Option 3 should prompt for custom URL

Breaking Changes

None. This is a backward-compatible enhancement.


Related Issues

Closes any issues related to local installation authentication configuration.


Checklist

  • Code follows project coding standards
  • Commit message follows Conventional Commits format
  • Documentation updated
  • Changes tested manually
  • Pushed to fork for PR review

esc247 added 3 commits March 19, 2026 17:36
add server URL selection for Clara Companion authentication
…selection

- Changed command name from 'clara_companion' to 'clara-companion' throughout codebase
- Updated all user-facing messages to use 'clara-companion' consistently
- Added Local vs Cloud selection option in login command
- Users can now choose between local installation (localhost:3000) or ClaraVerse Cloud
- Updated documentation files (README.md, companion.md, blog post)
- Updated frontend MCP setup instructions in AuthStep.tsx

Files modified:
- backend/mcp-bridge/cmd/clara_companion/main.go
- backend/mcp-bridge/internal/commands/*.go
- backend/mcp-bridge/internal/bridge/websocket.go
- frontend/src/components/mcp-setup/steps/AuthStep.tsx
- README.md
- docs-site/docs/features/companion.md
- docs-site/blog/2025-06-15-how-we-built-mcp-bridge.md
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.

1 participant