CLI

Here you'll get an overview of the Highflame Command Line Interface (CLI). It's a fast, efficient way for developers and administrators to manage Highflame 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

To get started, make sure you have the CLI installed:

pip install highflame-cli

Set Up Environment Variables

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

export HIGHFLAME_BASE_URL=your_base_url
export HIGHFLAME_API_KEY=your_api_key

Common Commands

CLI Authentication

highflame-cli auth

Provider Management

Create a Provider

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

List All Providers

highflame-cli provider list

Get a Specific Provider

highflame-cli provider get --name "example_provider"

Update a Provider

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

Create a Secret

highflame-cli 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

highflame-cli  secret list

Update a Secret

jahighflame-cli 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

highflame-cli secret delete --api_key "example_api_key" --provider_name "example_provider"

Create a Template

highflame-cli 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

highflame-cli template list

Get a Specific Template

highflame-cli template get --name "example_template"

Update a Template

highflame-cli  template update --name "example_template" --description "Updated description"

Delete a Template

highflame-cli  template delete --name "example_template"