Skip to main content
TapKit uses API keys to authenticate. You’ll get one from your TapKit dashboard.

​
Interactive login

This opens your browser for OAuth, or you can paste an API key directly. 
tapkit auth login

# ? How would you like to authenticate?
#   > Open browser (OAuth)
#     Paste API key
#
# Authenticated as tj@jootsing.com
# API key saved to ~/.tapkit/config.json

​
Verify your setup

Check that the companion app is running and a phone is connected. 
tapkit status

# ✓ Authenticated        tj@jootsing.com
# ✓ TapKit Mac App       Running (v2.1.0)
# ✓ Phone connected      iPhone 15 Pro (A1B2C3)

​
Environment variable

For scripts and CI, set the API key as an environment variable: 
export TAPKIT_API_KEY=tk_your_api_key

​
Session tokens

Generate a short-lived session token when OAuth isn’t available (headless/CI environments): 
tapkit auth token
# ses_abc123def456...  (expires in 24h)

# Use in CI:
export TAPKIT_API_KEY=ses_abc123def456

​
Auth precedence

TapKit checks for credentials in this order:
  1. --api-key flag (highest priority)
  2. TAPKIT_API_KEY environment variable
  3. ~/.tapkit/config.json
  4. Interactive login prompt