CLI

Here you'll get an overview of the Javelin Command Line Interface (CLI). It's a fast, efficient way for developers and administrators to manage Javelin resources directly from their terminal, perfect for scripting, automation, and quick administrative tasks. Built on top of the Python SDK, it offers the same powerful functionality.

Installation and Setup

The CLI is included with the Javelin SDK. To get started, make sure you have the SDK installed:

pip install javelin-sdk

Set Up Environment Variables

The CLI uses environment variables for authentication. You'll need to set your Javelin base URL and API key. You can find your API key in the Javelin console under Account -> Developer Settings.

export JAVELIN_BASE_URL=your_base_url
export JAVELIN_API_KEY=your_api_key

Common Commands

CLI Authentication

javelin auth

Provider Management

Create a Provider

javelin provider create --name "example_provider" --type "closed" --config '{"api_version": "v1", "deployment_name": "example_deployment", "organization": "example_org"}'

List All Providers

javelin provider list

Get a Specific Provider

javelin provider get --name "example_provider"

Update a Provider

javelin provider update --name "example_provider" --config '{"api_base" "https://new-api.provider.com"}'

Delete a Provider

javelin provider delete --name "example_provider"

Route Management

Create a Route

javelin route create --name "example_route" --type "completion" --enabled true --models '[{"name": "model1", "provider": "provider1", "suffix": "suffix1"}, {"name": "model2", "provider": "provider2", "suffix": "suffix2"}]' --config '{"organization": "example_org", "owner": "owner1", "rate_limit": 1000, "retries": 3, "archive": true, "retention": 30, "dlp": {"enabled": true, "strategy": "block", "action": "alert"}}'

List a Route

javelin route list

Get a Specific Route

javelin route get --name "example_route"

Update a Route

javelin route update --name "example_route" --config '{"rate_limit": 20, "budget": {"enabled": false}}'

Delete a Route

javelin route delete --name "example_route"

Create a Secret

javelin secret create --api_key "example_api_key" --api_key_secret_name "example_secret_name" --api_key_secret_key "example_secret_key" --provider_name "example_provider" --query_param_key "example_param_key" --header_key "example_header_key" --group "example_group" --enabled true

List All Secrets

javelin secret list

Update a Secret

javelin secret update --api_key "example_api_key" --api_key_secret_name "example_secret_name" --api_key_secret_key "new_secret_key" --enabled false

Delete a Secret

javelin secret delete --api_key "example_api_key" --provider_name "example_provider"

Create a Template

javelin template create --name "example_template" --description "A template for testing" --type "inspect" --enabled true --models '[{"name": "Sensitive Data Protection", "provider": "Google Cloud", "suffix": ""}]' --config '{"infoTypes": [{"name": "Personal Identifier", "regex": "\b\d{3}-\d{2}-\d{4}\b"}], "likelihood": "Likely", "notify": true}'

List All Templates

javelin template list

Get a Specific Template

javelin template get --name "example_template"

Update a Template

javelin template update --name "example_template" --description "Updated description"

Delete a Template

javelin template delete --name "example_template"

What's Next?

• For more programmatic controls, explore the SDK.

• To see these commands in action, browse the AI Security Platform section of our documentation.