For the complete documentation index, see llms.txt. This page is also available as Markdown.

profile

Manage named CLI profiles — each profile bundles an API token, base URL, and per-profile defaults so one binary can target multiple accounts or regions.

Note: profile commands are LOCAL and modify ~/.celigo/config. The one exception is whoami, which makes a read-only API call to resolve the active token's identity.

Supports all global flags.

Subcommands

Command
Purpose

list

List every profile with active marker, mode, base URL, and redacted token.

show

Print one profile's config (tokens redacted). Defaults to the active profile.

whoami

Resolve the active token to the user it authenticates as (live API call).

use

Switch the active profile.

add

Create a new profile.

delete

Delete a profile.

rename

Rename a profile without re-entering credentials.

celigo profile list

List every profile stored in ~/.celigo/config.json. The active profile is marked; non-default modes are flagged; tokens are redacted.

celigo profile list

Output respects --format / --jq; when JSON is requested each entry exposes name, active, mode, base_url, and a redacted api_token.

celigo profile show

Print a single profile's configuration with the token redacted. Defaults to the active profile when [name] is omitted.

Argument
Type
Required
Description

[name]

string

No

Profile to inspect. Defaults to the active profile.

celigo profile whoami

Resolve the active profile's API token to the user it authenticates as. Unlike the other profile commands, this makes a live, read-only API call. Use it to confirm which account/user a token belongs to — e.g. right after profile use to verify you switched to the intended account.

Returns the _userId the token resolves to. Respects --format / --jq.

Corresponds to: GET /v1/tokenInfo (operationId: getTokenInfo).

celigo profile use

Switch the active profile. The name must already exist — use add first.

Argument
Type
Required
Description

<name>

string

Yes

Profile to activate.

celigo profile add

Create a new profile. If --api-token is omitted and stdin is a TTY, the CLI prompts for the token with echo disabled. If the new profile is the only one in the file it is automatically marked active.

Argument
Type
Required
Description

<name>

string

Yes

Profile name.

Flag
Type
Default
Description

--api-token <token>

string

API token for the profile. If omitted, prompted on TTY; falls back to the root --token flag when provided.

--api-base-url <url>

string

https://api.integrator.io

API base URL. Use your region's API host. See Profiles & regions.

--default-format <format>

json | table

Default output format for this profile.

--mode <mode>

read | operate | full

full

Permission mode. See profiles guide.

celigo profile delete

Delete a profile. Cannot delete the active profile — switch first with use. Prompts for confirmation unless -y is passed.

⚠️ Deleting a profile removes its stored token and settings. This cannot be undone from the CLI; re-adding the profile requires the API token again.

Argument
Type
Required
Description

<name>

string

Yes

Profile to remove.

Flag
Type
Default
Description

-y, --yes

boolean

false

Skip the confirmation prompt.

celigo profile rename

Rename a profile. If the profile being renamed is the active one, the active pointer is updated to the new name.

Argument
Type
Required
Description

<oldName>

string

Yes

Existing profile name.

<newName>

string

Yes

New name. Must not already exist.

Gotchas

  • Tokens are stored in plaintext. ~/.celigo/config.json is created with mode 0600 on Unix; the CLI redacts tokens on output but anyone with file read access to your home directory can read them. Prefer CELIGO_API_TOKEN for CI.

  • Region is encoded in base_url, not the token. A token authenticates only against its own region's base URL. Any other base URL returns 401 Unauthorized. Keep one profile per region. See Profiles & regions.

  • No profile edit. To change a field on an existing profile use celigo config set against that profile (combine with --profile <name> to target a non-active profile) or delete and re-add.

  • Mode is enforced at every command. read blocks all mutations; operate allows a narrow allow-list of fields (disabled, debugUntil, schedule, autoResolveAt); full is unrestricted. See profiles guide.

  • Precedence. The active profile is the default, but --profile <name> overrides per invocation; CELIGO_API_TOKEN and --token override the token regardless of the profile in use.

  • First profile auto-activates. When the config file is empty, profile add marks the new profile active. Subsequent adds do not.

  • config — read and write individual keys on a profile without delete/re-add.

  • profiles guide — conceptual overview, region matrix, CI recipes, and permission modes.

  • global flags--profile <name> for per-invocation overrides.

Last updated

Was this helpful?