Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cirron.com/llms.txt

Use this file to discover all available pages before exploring further.

​
cirron config

Unified configuration management for the Cirron CLI. The config command manages three scopes of configuration — CLI settings (API URL, timeout, retries), global user preferences, and project-level settings — as well as a hardware subcommand for ML hardware profiles.

​
Usage

cirron config [options]
cirron config --scope <scope> [options]
cirron config hardware [options]

​
Scopes

ScopeDescriptionStorage
cliAPI URL, timeout, retries, auth token~/.cirron/config.json
globalUser preferences shared across projects~/.cirron/settings.json
projectProject-specific behavior settingscirron.yaml in project root
When no scope is specified:
  • --list shows all scopes
  • --get walks the resolution chain (project > global > cli)
  • --set defaults to project scope
  • --edit prompts for scope selection
  • --export, --import, --reset, --delete require an explicit --scope

​
Options

OptionDescriptionDefault
--scope <scope>Configuration scope (cli, global, project)Auto
--list, -lList configuration settingsfalse
--get, -g <key>Get a specific configuration value-
--set, -s <key=value>Set a configuration value-
--delete, -d <key>Delete a configuration value-
--resetReset configuration to defaultsfalse
--edit, -eInteractive configuration editorfalse
--explain <key>Show setting resolution chain across scopes-
--export <file>Export configuration to file-
--import <file>Import configuration from file-
--template, -t <name>Apply a settings template-
--verboseVerbose outputfalse
--jsonOutput in JSON formatfalse

​
CLI Scope

The CLI scope manages connection and request settings.

​
Configuration Keys

KeyDescriptionDefaultValid Values
apiUrlCirron API URLhttps://app.cirron.comValid URL
defaultEnvDefault environment for commandsproductiondevelopment, staging, production
timeoutRequest timeout in milliseconds300001000-300000
retriesNumber of retry attempts for failed requests30-10
# List CLI config
cirron config --scope cli --list

# Set API URL
cirron config --scope cli --set apiUrl=https://app.cirron.com

# Set default environment
cirron config --scope cli --set defaultEnv=staging

# Set timeout
cirron config --scope cli --set timeout=60000

# Reset CLI config to defaults
cirron config --scope cli --reset

​
Global Scope

The global scope stores user preferences that apply across all projects. 
# List global settings
cirron config --scope global --list

# Set a global preference
cirron config --scope global --set <key>=<value>

# Edit global settings interactively
cirron config --scope global --edit

# Export global settings
cirron config --scope global --export settings-backup.json

# Import global settings
cirron config --scope global --import settings-backup.json

​
Project Scope

The project scope stores settings specific to the current project (stored in cirron.yaml). 
# List project settings
cirron config --scope project --list

# Set a project setting
cirron config --scope project --set <key>=<value>

# Edit project settings interactively
cirron config --scope project --edit

# Apply a settings template
cirron config --scope project --template <name>

​
Setting Resolution

Use --explain to see how a setting is resolved across scopes: 
cirron config --explain defaultEnv
This shows the value at each scope level and which one takes precedence.

​
Interactive Mode

Run cirron config without options to enter interactive mode, which prompts for scope selection: 
cirron config

Which configuration scope would you like to manage?
> CLI Configuration (API URL, timeout, retries)
  Global Settings (user preferences)
  Project Settings (project behavior)

​
Hardware Subcommand

Manage hardware configuration for ML models. This subcommand detects, configures, and manages hardware profiles used for compilation and build operations.

​
Usage

cirron config hardware [options]

​
Hardware Options

OptionDescriptionDefault
--detectDetect current device hardwarefalse
--configureConfigure hardware interactivelyfalse
--listList available hardware profilesfalse
--profile <name>Use specific hardware profile-
--save [filename]Save hardware configuration to file-
--from <path>Load hardware configuration from file-
--currentUse current device specificationsfalse
--jsonOutput in JSON formatfalse
--verboseShow detailed informationfalse

​
Hardware Detection

# Auto-detect current device hardware
cirron config hardware --detect

# Detect and save to file
cirron config hardware --detect --save my-hardware.json

# Detect with JSON output
cirron config hardware --detect --json
Detection reports CPU, memory, GPU, CUDA availability, and framework compatibility (PyTorch, TensorFlow, scikit-learn).

​
Hardware Configuration

# Interactive hardware configuration
cirron config hardware --configure

# Configure from a saved profile
cirron config hardware --configure --from my-hardware.json

# List available preset profiles
cirron config hardware --list
Configuration modes:
  • Auto-detect: Use current device hardware
  • Preset profiles: Select from pre-configured hardware profiles
  • Manual: Specify hardware type, architecture, CPU, GPU, and CUDA settings

​
Applying to Projects

When run inside a project directory (with cirron.yaml), hardware detection and configuration can be applied directly to the project. The command prompts to save the configuration and optionally apply it to the current project.

​
Examples

​
Initial Setup

# Interactive setup
cirron config

# Set API endpoint and environment
cirron config --scope cli --set apiUrl=https://your-app.cirron.com
cirron config --scope cli --set defaultEnv=development

​
Environment-Specific Configuration

# Development settings
cirron config --scope cli --set defaultEnv=development
cirron config --scope cli --set timeout=60000

# Production settings
cirron config --scope cli --set defaultEnv=production
cirron config --scope cli --set timeout=30000

​
Hardware Setup for ML

# Detect and configure hardware
cirron config hardware --detect

# List available profiles
cirron config hardware --list

# Apply a saved hardware profile
cirron config hardware --configure --from team-hardware.json

​
Security Features

​
Token Masking

Authentication tokens are automatically masked when displayed: 
cirron config --scope cli --get token
# Output: token: abc12345********

​
Secure Deletion

Only authentication tokens can be deleted via the config command: 
# This works
cirron config --scope cli --delete token

# For other auth operations, use:
cirron auth logout

​
Configuration Storage

​
File Locations

  • CLI config: ~/.cirron/config.json
  • Global settings: ~/.cirron/settings.json
  • Project settings: cirron.yaml in project root
  • Hardware profiles: ~/.cirron/hardware/ directory

​
Environment Variables

Some configuration can be overridden with environment variables: 
# Override API URL
CIRRON_API_URL=https://custom-app.cirron.com cirron build

# Override timeout
CIRRON_TIMEOUT=60000 cirron deploy
  • cirron auth - Manage authentication
  • cirron info —hardware - Quick hardware detection (shortcut for cirron config hardware --detect)
  • cirron info —diagnostics - Run diagnostic checks
  • cirron status - Check system status