edge-cli

Cross-platform CLI for the Edge API.

Install

Requires Node.js 20+.

npm install -g @youkno/edge-cli

From source (for contributors)

cd edge-cli
yarn install
yarn build
yarn node dist/index.js --help

Configure

Create ~/.edge-api with your product and environment:

PRODUCT=regulars
ENV=prod

Available products: youkno, stash, alleaves, vera, vip, dinamo1948, propatrimonio, campaigns. Each has a bundled API URL, so no BASE_URL is needed unless you want to override it.

If no product is provided (--product or PRODUCT= in .edge-api), edge-cli shows an interactive product selector when running in a TTY.

Config file resolution

.edge-api files are read in order and merged:

1. /etc/edge-api (system-wide)
2. ./.edge-api (project-local)
3. ~/.edge-api (user home)

Authenticate

edge-cli login

This opens your browser to the admin sign-in page. After signing in, tokens are saved to ~/.edge-cli-auth/accounts.json.

edge-cli login:list          # see saved accounts
edge-cli login:use <email>   # switch default account
edge-cli logout              # logout current account
edge-cli logout <email>      # logout specific account

Commands

# Check connectivity
edge-cli health-check

# Print effective config (product, env, baseUrl, config files)
edge-cli config

# Get an API token (useful for Postman or curl)
edge-cli token
edge-cli token --refresh     # force token refresh
edge-cli token --header      # print as Authorization header

# Run a shell command
edge-cli shell "<command>"

# Run a script file
edge-cli shell script.esh

# Shell with options
edge-cli shell --dry-run "<command>"         # validate without executing
edge-cli shell --validate "<command>"        # syntax check only
edge-cli shell --json "<command>"            # JSON output
edge-cli shell --continue-on-error script.esh
edge-cli shell -v key=value "<command>"      # pass variables

# Upload users CSV
edge-cli upload-users users.csv
edge-cli upload-users -q users.csv           # quiet mode
edge-cli upload-users -l users.csv           # list mode
edge-cli upload-users -p users.csv           # preview mode

# Set/clear default product
edge-cli product:default regulars
edge-cli product:default --clear

Global flags

| Flag | Description | |---|---| | --product <name> | Override product (default from ~/.edge-api) | | --env <env> | prod, devel, or devlocal (default: prod) | | --base-url <url> | Override API URL | | --client <clientId> | Client ID for client-scoped operations | | --config-path <path> | Additional config file path |

Help

edge-cli --help
edge-cli <command> --help