Skip to main content

Migration Guide: v6 → v7

Complete migration guide covering all features introduced in v6 and v7, including customizable auth, variant-specific configuration, remote CLIProxy support, new OAuth providers, and token refresh improvements.

Version Overview


Breaking Changes Summary

Review all breaking changes before upgrading to v7.

v7.2 Breaking Changes

None - Fully backward compatible with v7.1

v7.1 Breaking Changes

None - Fully backward compatible with v6

v6 Breaking Changes

Config Schema:
  • config.jsonconfig.yaml (automatic migration)
  • New required field: version: 6
  • cliproxy.auth structure changed (automatic migration)
CLI Flags:
  • --proxy-server deprecated → use --proxy-host
  • --proxy-auth deprecated → use --proxy-auth-token

Migration Checklist

1

Backup Configuration

CCS creates automatic backups, but a manual backup is recommended.
2

Update CCS

3

Verify Migration

4

Test Profiles


New Features in v7.2

1. Kiro OAuth Support (HIGH PRIORITY)

What’s New:
  • Full OAuth support for Kiro provider (AWS Bedrock Claude)
  • Browser-based authentication flow
  • Token import from Kiro IDE
Migration Steps:
Browser opens for AWS SSO login. Authenticate and grant access.
Configuration:
CLI Flags: Use Cases:
  • Access AWS Bedrock Claude via Kiro
  • Use Claude via AWS SSO with MFA
  • Persistent AWS session (no re-auth)

2. GHCP Device Code Flow (HIGH PRIORITY)

What’s New:
  • GitHub Copilot (GHCP) provider now uses Device Code flow
  • No headless browser required
  • Better support for SSH/remote environments
Migration Steps:
Configuration:
CLI Usage:
Benefits:
  • Works in SSH sessions
  • No browser automation
  • More reliable auth flow
  • Better UX for remote development

New Features in v7.1

3. Remote CLIProxy Support (HIGH PRIORITY)

What’s New:
  • Connect to remote CLIProxyAPI server
  • Share proxy across multiple machines
  • Fallback to local proxy if remote unreachable
Migration Steps:
1

Configure Remote Proxy

2

Test Connection

This will try the remote proxy first. Check logs for connection status:
3

Force Remote Only

Fails with PROXY_ERROR if the remote proxy is unreachable.
CLI Flags: Environment Variables:
Use Cases:
  • Centralized proxy for teams
  • Share OAuth credentials across machines
  • Reduce per-machine setup
  • Better security (credentials on server only)
Architecture:
Security:
  • Use HTTPS for production
  • Separate management_key for admin endpoints
  • Rotate tokens regularly
  • Use firewall rules for access control

4. Proactive Token Refresh (HIGH PRIORITY)

What’s New:
  • Automatic token refresh 5 minutes before expiration
  • Prevents mid-session auth failures
  • Supports Gemini, Codex, Antigravity, Qwen, iFlow
Migration Steps: No action required - Automatic for all OAuth providers How It Works:
1

Token Expiry Check

Before each API request, CCS checks token expiration.
2

Proactive Refresh

If token expires in <5 minutes, refresh automatically.
3

Seamless Session

User experiences no interruption.
Configuration:
Logging: Enable debug logs to see refresh activity:
Benefits:
  • No mid-session auth failures
  • Better user experience
  • Reduced support tickets

New Features in v6

5. Customizable Management Key (HIGH PRIORITY)

What’s New:
  • Separate management_key from api_key
  • Enhanced security for admin endpoints
  • Per-variant auth override
Migration from v5:
Configuration:
Use Cases:
  • Separate API vs admin credentials
  • Different auth per environment (dev/prod)
  • Enhanced security for production

6. Variant-Specific Auth (HIGH PRIORITY)

What’s New:
  • Per-variant auth override
  • Different credentials per variant
  • Isolate dev/prod environments
Migration Steps:
# Before v6 - Single auth for all variants cliproxy: auth:
Use Cases:
  • Separate dev/prod credentials
  • Per-team auth keys
  • Testing with different API keys
  • Security isolation

7. Port Isolation for Variants (MEDIUM PRIORITY)

What’s New:
  • Assign unique ports to variants (8318-8417)
  • Run multiple variants concurrently
  • Avoid port conflicts
Migration Steps:
Port Range:
  • 8317: Default local proxy (reserved)
  • 8318-8417: Available for variants (100 ports)
Use Cases:
  • Run dev and prod simultaneously
  • Multi-user environments
  • Isolated testing
CLI Usage:

Configuration Priority Resolution

CCS resolves configuration values in this priority order:
Example:
Result: CLI flag overrides env var, env var overrides config file.

Multi-Account OAuth Workflow

New in v6+: Multi-account support for all OAuth providers
1

Add First Account

Browser opens for authentication. The account is saved with the email as the default nickname.
2

Add Second Account

Authenticate with a different account.
3

List Accounts

Example output:
4

Switch Account

5

Rename Account

After renaming, switch with:
Configuration:
CLI Flags:

Troubleshooting Migration Issues

Issue: Migration Failed


Issue: Remote Proxy Connection Failed


Issue: Token Refresh Failed


Issue: Port Conflict


Rollback Guide

If migration fails, rollback to previous version:
1

Stop All CCS Processes

2

Restore Backup

3

Downgrade CCS

4

Verify


Feature Adoption Roadmap

Recommended adoption order for v6/v7 features:

Week 1: Core Migration

  • Update to v7.2 - Verify automatic migration - Test existing profiles - Run ccs doctor --fix

Week 2: New Providers

  • Set up Kiro OAuth - Migrate GHCP to Device Code flow - Test multi-account workflows

Week 3: Remote Proxy

  • Deploy remote CLIProxy (if team) - Configure fallback - Test connection stability

Week 4: Advanced Features

  • Implement port isolation - Configure variant-specific auth - Set up monitoring/analytics

Environment Variables Reference

New environment variables in v6/v7:

API Endpoints (New in v7)

Dashboard API endpoints for remote proxy management:

CLIProxy Control

Usage Analytics

Related:

Next Steps

Configuration Schema

Complete config.yaml v6 reference

File Locations

Where CCS stores data

CLI Flags

All CLI flags and options

Troubleshooting

Common issues and solutions