Bootspring
HomeGet Started

Auth Commands

Manage Bootspring authentication and API keys.

Synopsis#

Loading code block...

Commands#

CommandDescription
loginAuthenticate with Bootspring
logoutLog out and clear credentials
statusCheck authentication status
tokenDisplay or refresh API token

bootspring auth login#

Authenticate with your Bootspring account.

Usage#

Loading code block...

Options#

OptionDescription
--key <key>Provide API key directly
--browserOpen browser for OAuth login

Examples#

Loading code block...

Output:

Bootspring Authentication ═══════════════════════════════════════════════════════════════════ ? Enter your API key: bsk_************************ Verifying... ✓ Authenticated successfully Account: john@example.com Tier: Pro Expires: Never API key saved to: ~/.bootspring/credentials
Loading code block...

Browser login flow:

Opening browser for authentication... Visit this URL if browser doesn't open: https://bootspring.com/auth/cli?token=abc123 Waiting for authentication... ✓ Authenticated successfully

bootspring auth logout#

Log out and remove stored credentials.

Usage#

Loading code block...

Options#

OptionDescription
--allLog out from all devices

Example#

Loading code block...

Output:

Logged out successfully Credentials removed from: ~/.bootspring/credentials

bootspring auth status#

Check current authentication status.

Usage#

Loading code block...

Options#

OptionDescription
--jsonOutput as JSON

Example#

Loading code block...

Output (authenticated):

Authentication Status ═══════════════════════════════════════════════════════════════════ Status: Authenticated ✓ Account: john@example.com Tier: Pro Devices: 3/5 used API Usage This Month ──────────────────── Calls: 4,521 / 10,000 (45%) Reset: April 1, 2024

Output (not authenticated):

Authentication Status ═══════════════════════════════════════════════════════════════════ Status: Not authenticated Log in with: bootspring auth login Get API key at: https://bootspring.com/dashboard/api-keys

bootspring auth token#

Display or refresh the API token.

Usage#

Loading code block...

Options#

OptionDescription
--showDisplay the current token
--refreshRefresh the token
--copyCopy token to clipboard

Examples#

Loading code block...

Output:

API Token ═══════════════════════════════════════════════════════════════════ Token: bsk_************************4f3a Type: Pro Valid: Yes Use --show to display full token
Loading code block...

Output:

API Token ═══════════════════════════════════════════════════════════════════ Token: bsk_live_1234567890abcdef1234567890abcdef4f3a ⚠️ Keep this token secret! Don't share or commit to version control.
Loading code block...

API Key Management#

Getting an API Key#

  1. Visit https://bootspring.com/dashboard
  2. Go to Settings > API Keys
  3. Click "Create New Key"
  4. Copy and save your key securely

Key Types#

TypeUsagePermissions
DevelopmentLocal developmentFull access
CI/CDAutomated pipelinesQuality checks only
Read-onlyDocumentation accessRead context only

Storing Keys#

Keys are stored in ~/.bootspring/credentials:

Loading code block...

Or use environment variable:

Loading code block...

Security Best Practices#

DO#

  • Store keys in environment variables
  • Use CI/CD-specific keys for pipelines
  • Rotate keys periodically
  • Use read-only keys when possible

DON'T#

  • Commit keys to version control
  • Share keys with others
  • Use production keys in development
  • Store keys in plain text files in project

Revoking Keys#

If a key is compromised:

  1. Go to https://bootspring.com/dashboard/api-keys
  2. Find the compromised key
  3. Click "Revoke"
  4. Generate a new key

Troubleshooting#

Invalid API Key#

Error: Invalid API key

Solutions:

  1. Verify key is correct
  2. Check key hasn't been revoked
  3. Ensure key has required permissions

Expired Session#

Error: Session expired

Solutions:

  1. Run bootspring auth login again
  2. Check account status at dashboard

Rate Limited#

Error: Rate limit exceeded

Solutions:

  1. Wait for rate limit reset
  2. Check usage at dashboard
  3. Consider upgrading tier

Related#