hiyve-cli

Command-line tool for configuring npm to use the private Hiyve SDK registry.

Quick Start

# One command to authenticate and configure npm
npx hiyve-cli login

After login, you can install Hiyve packages normally:

npm install @hiyve/rtc-client
npm install @hiyve/auth
npm install @hiyve/auth-react

Commands

hiyve login

Authenticate with Hiyve and configure npm for @hiyve packages.

# Interactive mode (prompts for API key)
npx hiyve-cli login

# With API key as argument
npx hiyve-cli login --key mk_your_api_key_here

hiyve logout

Remove Hiyve configuration from your ~/.npmrc file.

npx hiyve-cli logout

hiyve whoami

Show current authentication status.

npx hiyve-cli whoami

Getting Your API Key

1. Log in to the Hiyve SDK Admin Portal
2. Navigate to API Keys in the sidebar
3. Copy your API key (starts with mk_)

What Does Login Do?

The login command:

1. Validates your API key with the Hiyve registry
2. Adds two lines to your ~/.npmrc file:
   • @hiyve:registry=https://console.hiyve.dev/api/registry/
   • //:_authToken=your_api_key

This tells npm to fetch @hiyve/* packages from the private Hiyve registry instead of the public npm registry.

Troubleshooting

"Invalid API key" error

• Make sure your API key starts with mk_
• Check that your API key is 35 characters long
• Verify your account is active in the admin portal

"Connection failed" error

• Check your internet connection
• The registry may be temporarily unavailable

Packages not installing

After login, verify your configuration:

npx hiyve-cli whoami

Or check your ~/.npmrc manually:

cat ~/.npmrc | grep hiyve

Security

• Your API key is stored in ~/.npmrc (standard npm token storage)
• The API key is sent only to console.hiyve.dev
• Run hiyve logout to remove your credentials

Support

• Documentation: https://docs.hiyve.io
• Issues: https://github.com/hiyve/hiyve-sdk/issues
• Email: [email protected]