Developer Tools

CLI Reference

The JustKalm CLI lets you interact with the API directly from your terminal. Build automation scripts, test webhooks locally, and manage resources.

brew install justkalm/tap/justkalm

Installation

Install Methods

# macOS (Homebrew)
brew install justkalm/tap/justkalm

# Linux (apt)
curl -fsSL https://cli.justkalm.com/install.sh | bash

# Windows (Scoop)
scoop bucket add justkalm https://github.com/justkalm/scoop-bucket
scoop install justkalm

# npm (Node.js)
npm install -g @justkalm/cli

# pip (Python)
pip install justkalm-cli

# Direct download
curl -L https://cli.justkalm.com/releases/latest/justkalm-darwin-arm64 -o justkalm
chmod +x justkalm && sudo mv justkalm /usr/local/bin/

Commands

Authentication

justkalm loginAuthenticate with your JustKalm account

justkalm login

justkalm logoutClear local authentication credentials

justkalm logout

justkalm whoamiDisplay current authenticated user

justkalm whoami

Valuations

justkalm valuateCreate a product valuation

----brand----category----condition----output

justkalm valuate --brand "Louis Vuitton" --category bags --condition excellent

justkalm valuate batchBatch valuate from CSV/JSON

----file----output----format

justkalm valuate batch --file products.csv --output results.json

justkalm valuate statusCheck valuation status

justkalm valuate status val_abc123

API Keys

justkalm keys listList all API keys

justkalm keys list

justkalm keys createCreate a new API key

----name----permissions----expires

justkalm keys create --name "CI/CD" --permissions read,write

justkalm keys revokeRevoke an API key

justkalm keys revoke key_abc123

Webhooks

justkalm webhooks listList webhook endpoints

justkalm webhooks list

justkalm webhooks listenForward webhooks to localhost

----forward-to----events

justkalm webhooks listen --forward-to localhost:3000/webhooks

justkalm webhooks triggerTrigger a test event

justkalm webhooks trigger valuation.completed

justkalm webhooks replayReplay a past event

justkalm webhooks replay evt_abc123

Configuration

justkalm config setSet a configuration value

justkalm config set api_key sk_live_xxx

justkalm config getGet a configuration value

justkalm config get api_key

justkalm config listList all configuration

justkalm config list

Logs

justkalm logsTail API request logs

----filter----format----since

justkalm logs --filter "status_code=500" --since 1h

justkalm logs exportExport logs to file

justkalm logs export --since 24h --output logs.json

Configuration

~/.justkalm/config.yaml

# ~/.justkalm/config.yaml
default_project: my-project
output_format: json

environments:
  production:
    api_key: sk_live_...
    base_url: https://api.justkalm.com
  
  development:
    api_key: sk_test_...
    base_url: https://api.justkalm.com

preferences:
  color: true
  pager: less
  editor: vim

Environment Variables

Variable	Description	Required
JUSTKALM_API_KEY	API key for authentication
JUSTKALM_BASE_URL	API base URL (default: https://api.justkalm.com)	—
JUSTKALM_CONFIG_DIR	Config directory path (default: ~/.justkalm)	—
JUSTKALM_NO_COLOR	Disable colored output	—
JUSTKALM_DEBUG	Enable debug logging	—

CI/CD Integration

Automation Script Example

#!/bin/bash
# CI/CD Integration Example

set -e

# Authenticate using environment variable
export JUSTKALM_API_KEY=$JUSTKALM_SECRET_KEY

# Validate API key
justkalm whoami || exit 1

# Run batch valuation
echo "Starting batch valuation..."
justkalm valuate batch \
  --file ./products/inventory.csv \
  --output ./results/valuations.json \
  --format json

# Check for failures
FAILED=$(jq '.[] | select(.status == "failed")' ./results/valuations.json | wc -l)
if [ "$FAILED" -gt 0 ]; then
  echo "Warning: $FAILED valuations failed"
  exit 1
fi

echo "Batch valuation completed successfully"

# Upload results to S3 (optional)
aws s3 cp ./results/valuations.json s3://my-bucket/valuations/$(date +%Y-%m-%d).json

Global Flags

--api-keyOverride API key for single command

--outputOutput format: json, table, yaml

--envEnvironment: production, development

--quietSuppress non-essential output

--debugEnable debug logging

--versionDisplay CLI version

--helpShow help for any command

--no-colorDisable colored output

Ready to Automate?

Install the CLI and start integrating JustKalm into your workflows.

Get Started View on GitHub