Usage

The Arxignis CLI is a command-line tool for managing your Arxignis sites and configurations. This guide will help you get started with the available commands and their usage.

Installation

Start here

Authentication

Before using the CLI, you need to authenticate with your Arxignis account.

Initial Setup

ax init

This command will: 1. Check if you have a login token 2. If not, open the registration page 3. Prompt for your token 4. Ask for your domain name and target 5. Create a configuration file

ax login

This command will prompt you for your authentication token.

Register

ax register

This command will open the registration page in your default browser.

Site Management

List Sites

ax site list

Options: - -d, --domain <domain>: Filter sites by domain name (optional)

Create Site

ax site create -d <domain>

Options: - -d, --domain <domain>: Domain name (required)

Cache Management

Purge Specific URL

ax purge url-purge -d <domain> -u <url>

Options: - -d, --domain <domain>: Domain name (required) - -u, --url <url>: URL to purge (required)

Purge All URLs

ax purge all -d <domain>

Options: - -d, --domain <domain>: Domain name (required)

Site Settings

Update Site Settings

ax settings -d <domain> -c <config-path>

Options: - -d, --domain <domain>: Domain name (required) - -c, --config <path>: Path to the configuration file (required)

Configuration File Format

The configuration file should be in YAML format with the following structure:

https_redirect: false
target: 'your-target-domain'
hsts_enabled: false
url_normalization: false
ssl: 'flexible'
av_scan: []
upload_limit: []
rate_limit: []
transformation:
  request_headers: []
  response_headers: []
rewrite: []
waf: []
yara: []

Token Storage

The CLI stores your authentication token in a local database at ~/.ax/cache.db.

Help

To see all available commands and options:

ax --help

For help with specific commands:

ax <command> --help