Tendrl

Tendrl CLI: Options Reference

Every command with its arguments, options, types, and defaults — generated from tendrl-cli 0.1.0 itself (scripts/gen_cli_reference.py in the CLI repo), so this page cannot drift from the shipped tool. JSON request-body shapes and worked examples live in the per-product pages: Contact, Strand, Surface.

Global options (before any command): --json prints the raw API response for scripting; --app-url <origin> targets another environment (default https://app.tendrl.com, env TENDRL_APP_URL); --version prints the CLI version.

login#

tendrl-cli login#

Sign in — opens your browser by default; --password for the old flow.

Option Type Default Description
--email, -e str Email for password sign-in (prompted if omitted).
--account str Account to sign into (if you belong to several).
--password flag Use email + password instead of the browser.
--no-browser flag Print the sign-in URL and paste the code (SSH/headless).

logout#

tendrl-cli logout#

Revoke the cached session and forget it locally.

whoami#

tendrl-cli whoami#

Show the signed-in user and active account.

Option Type Default Description
--permissions flag Also show your role's allowed actions.

accounts#

Accounts you belong to.

tendrl-cli accounts list#

List the accounts your user belongs to.

tendrl-cli accounts switch#

Switch the cached session to another account.

Argument Type Required Description
ACCOUNT str yes Account name, number, or path (see 'accounts list').

tendrl-cli accounts show#

Show the active account's details.

billing#

Plans and billing info.

tendrl-cli billing plans#

Show the public plan catalog for a product.

Option Type Default Description
--product, -p str contact contact, strand, or surface.

contact#

Contact — devices, messages, files, routing, dashboards, and access control.

tendrl-cli contact entities list#

List entities.

Option Type Default Description
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli contact entities get#

Show one entity.

Argument Type Required Description
ENTITY_ID str yes Entity name.

tendrl-cli contact entities create#

Register an entity (returns its key once — save it).

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact entities update#

Update an entity.

Argument Type Required Description
ENTITY_ID str yes Entity name.
Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact entities delete#

Delete an entity.

Argument Type Required Description
ENTITY_ID str yes Entity name.
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact entities reboot#

Ask a device to reboot.

Argument Type Required Description
ENTITY_ID str yes Entity name.

tendrl-cli contact entities heartbeat#

Show an entity's last heartbeat.

Argument Type Required Description
ENTITY_ID str yes Entity name.

tendrl-cli contact entities state#

Show an entity's state table.

Argument Type Required Description
ENTITY_ID str yes Entity name.

tendrl-cli contact entities provision-payload#

Fetch the provisioning payload for a device.

Argument Type Required Description
ENTITY_ID str yes Entity name.

tendrl-cli contact entities rotate-key#

Rotate a device's entity key (returned once).

Argument Type Required Description
ENTITY_ID str yes Entity name.

tendrl-cli contact entities boards#

List supported board profiles.

tendrl-cli contact messages list#

List recent messages.

Option Type Default Description
--entity str Filter by entity name.
--start str Start date (ISO 8601).
--end str End date (ISO 8601).
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli contact messages get#

Show one message.

Argument Type Required Description
MESSAGE_ID str yes Message id.

Search messages with a filter body.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact messages export#

Export messages to a file.

Option Type Default Description
--out, -o path Output file (default messages export).
--format str csv csv or json.

tendrl-cli contact files list#

List files on the account.

Option Type Default Description
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli contact files get#

Show file metadata.

Argument Type Required Description
FILE_ID str yes File id (see 'files list').

tendrl-cli contact files upload#

Upload a file for delivery to a device.

Argument Type Required Description
PATH path yes Local file to send.
Option Type Default Description
--dest str Destination entity or path.
--tags str Comma-separated tags.

tendrl-cli contact files download#

Download a file's bytes.

Argument Type Required Description
FILE_ID str yes File id (see 'files list').
Option Type Default Description
--out, -o path Output path (default: file id).

tendrl-cli contact files delete#

Delete a file.

Argument Type Required Description
FILE_ID str yes File id (see 'files list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact files rescan#

Re-run the Surface scan on a stored file.

Argument Type Required Description
FILE_ID str yes File id (see 'files list').

tendrl-cli contact fanouts list#

List fanouts.

tendrl-cli contact fanouts get#

Show one fanout.

Argument Type Required Description
FANOUT_ID str yes Fanout name.

tendrl-cli contact fanouts create#

Create a fanout.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact fanouts delete#

Delete a fanout.

Argument Type Required Description
FANOUT_ID str yes Fanout name.
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact fanouts add#

Add an entity to a fanout.

Argument Type Required Description
FANOUT_ID str yes Fanout name.
ENTITY str yes Entity name or resource path.

tendrl-cli contact fanouts remove#

Remove an entity from a fanout.

Argument Type Required Description
FANOUT_ID str yes Fanout name.
ENTITY_ID str yes Entity name.

tendrl-cli contact fanouts publish#

Publish a message to every entity in a fanout.

Argument Type Required Description
FANOUT_ID str yes Fanout name.
Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact directories list#

List directories.

tendrl-cli contact directories get#

Show one directory.

Argument Type Required Description
DIRECTORY_ID str yes Directory id (see 'directories list').

tendrl-cli contact directories create#

Create a directory.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact directories delete#

Delete a directory.

Argument Type Required Description
DIRECTORY_ID str yes Directory id (see 'directories list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact directories move#

Move a directory.

Argument Type Required Description
DIRECTORY_ID str yes Directory id (see 'directories list').
Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact dashboards list#

List dashboards.

tendrl-cli contact dashboards get#

Show one dashboard.

Argument Type Required Description
DASHBOARD_ID str yes Dashboard id (see 'dashboards list').

tendrl-cli contact dashboards fields#

Discover queryable data fields.

Option Type Default Description
--service str Service (payload schema) to inspect fields for.
--entity str Restrict field discovery to one entity.

tendrl-cli contact dashboards query#

Run a widget data query (see docs for the body shape).

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact alerts list#

List alerts.

tendrl-cli contact alerts get#

Show one alert.

Argument Type Required Description
ALERT_ID str yes Alert id (see 'alerts list').

tendrl-cli contact alerts create#

Create an alert.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact alerts update#

Update an alert.

Argument Type Required Description
ALERT_ID str yes Alert id (see 'alerts list').
Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact alerts delete#

Delete an alert.

Argument Type Required Description
ALERT_ID str yes Alert id (see 'alerts list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact alerts test#

Fire a test of an alert.

Argument Type Required Description
ALERT_ID str yes Alert id (see 'alerts list').

tendrl-cli contact flows list#

List flows.

tendrl-cli contact flows get#

Show one flow.

Argument Type Required Description
FLOW_ID str yes Flow id (see 'flows list').

tendrl-cli contact flows connectors#

List flow connectors.

tendrl-cli contact flows connector-templates#

List available connector templates.

tendrl-cli contact flows test-connector#

Test a connector configuration.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact services list#

List services.

tendrl-cli contact services get#

Show one service.

Argument Type Required Description
SERVICE_ID str yes Service name.

tendrl-cli contact services create#

Create a service schema.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact services delete#

Delete a service.

Argument Type Required Description
SERVICE_ID str yes Service name.
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact services validate#

Validate a service definition before creating it.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact insights summary#

Account overview.

tendrl-cli contact insights messages#

Message volume analytics.

tendrl-cli contact insights entities#

Entity analytics.

tendrl-cli contact insights validation#

Schema validation analytics.

tendrl-cli contact insights flows#

Flow analytics.

tendrl-cli contact insights usage#

Data usage against your plan.

tendrl-cli contact keys list#

List API keys.

tendrl-cli contact keys get#

Show one API key.

Argument Type Required Description
KEY_ID str yes API key id (see 'keys list').

tendrl-cli contact keys create#

Create an API key (token shown once — save it).

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact keys rotate#

Rotate an API key (new token shown once).

Argument Type Required Description
KEY_ID str yes API key id (see 'keys list').

tendrl-cli contact keys delete#

Delete an API key.

Argument Type Required Description
KEY_ID str yes API key id (see 'keys list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact users list#

List users on the account.

tendrl-cli contact users set-role#

Change a user's role.

Argument Type Required Description
USER_ID str yes User id (see 'users list' / 'team list').
ROLE str yes Role name.

tendrl-cli contact users remove#

Remove a user from the account.

Argument Type Required Description
USER_ID str yes User id (see 'users list' / 'team list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact users invites#

List pending invites.

tendrl-cli contact users invite#

Invite a user to the account.

Argument Type Required Description
EMAIL str yes Email address to invite.
Option Type Default Description
--role str Role for the invited user (e.g. ReadOnly).

tendrl-cli contact users revoke-invite#

Revoke a pending invite.

Argument Type Required Description
EMAIL str yes Invited email address (see 'users invites').

tendrl-cli contact roles list#

List roles.

tendrl-cli contact roles get#

Show one role.

Argument Type Required Description
ROLE_ID str yes Role name.

tendrl-cli contact roles create#

Create a role.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact roles delete#

Delete a role.

Argument Type Required Description
ROLE_ID str yes Role name.
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact policies list#

List policies.

tendrl-cli contact policies get#

Show one policy.

Argument Type Required Description
POLICY_ID str yes Policy name.

tendrl-cli contact policies create#

Create a policy.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli contact policies delete#

Delete a policy.

Argument Type Required Description
POLICY_ID str yes Policy name.
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli contact audit list#

List audit log entries.

Option Type Default Description
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli contact audit export#

Export the audit log.

Option Type Default Description
--out, -o path Output file (default tendrl-audit-log.csv).

tendrl-cli contact deployments list#

List deployments.

tendrl-cli contact deployments get#

Show one deployment.

Argument Type Required Description
DEPLOYMENT_ID str yes Deployment id (see 'deployments list').

tendrl-cli contact deployments create#

Create a deployment from local app files.

Argument Type Required Description
PATHS path yes App files to include in the deployment.
Option Type Default Description
--name str Deployment name.
--entry str Entry module (defaults to the device's app_entry).
--no-scan flag Skip the malware scan for these files.

tendrl-cli contact deployments deploy#

Roll out a deployment to its targets.

Argument Type Required Description
DEPLOYMENT_ID str yes Deployment id (see 'deployments list').

strand#

Strand — workflows, runs, connectors, and automation.

tendrl-cli strand audit#

List audit log entries.

Option Type Default Description
--resource-type str Filter by resource type (e.g. workflow, connector).
--action str Filter by action (e.g. create, delete).
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli strand whoami#

Show the account and role behind your Strand key.

tendrl-cli strand workflows list#

List workflows.

Option Type Default Description
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli strand workflows get#

Show one workflow.

Argument Type Required Description
WORKFLOW_ID str yes Workflow id (see 'workflows list').

tendrl-cli strand workflows create#

Create a workflow.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli strand workflows update#

Update a workflow's settings (name, schedule, tags, active).

Argument Type Required Description
WORKFLOW_ID str yes Workflow id (see 'workflows list').
Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli strand workflows delete#

Delete a workflow.

Argument Type Required Description
WORKFLOW_ID str yes Workflow id (see 'workflows list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli strand workflows run#

Queue a workflow run.

Argument Type Required Description
WORKFLOW_ID str yes Workflow id (see 'workflows list').
Option Type Default Description
--data, -d str JSON input payload (optional).
--file, -f path Read the JSON body from a file.
--version str Run a specific version id.

tendrl-cli strand workflows save#

Save a new immutable version of a workflow's graph.

Argument Type Required Description
WORKFLOW_ID str yes Workflow id (see 'workflows list').
Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli strand workflows versions#

List a workflow's versions.

Argument Type Required Description
WORKFLOW_ID str yes Workflow id (see 'workflows list').

tendrl-cli strand workflows export#

Export a workflow to a JSON file.

Argument Type Required Description
WORKFLOW_ID str yes Workflow id (see 'workflows list').
Option Type Default Description
--out, -o path Output file (default <id>.json).

tendrl-cli strand workflows import#

Import a workflow from an exported JSON file.

Argument Type Required Description
PATH path yes Exported workflow JSON file.
Option Type Default Description
--name str Name for the imported workflow.

tendrl-cli strand workflows schedule-presets#

List schedule presets.

tendrl-cli strand runs list#

List runs.

Option Type Default Description
--status str Filter by run status.
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli strand runs get#

Show one run.

Argument Type Required Description
RUN_ID str yes Run id (see 'runs list').

tendrl-cli strand runs steps#

List a run's steps.

Argument Type Required Description
RUN_ID str yes Run id (see 'runs list').

tendrl-cli strand runs cancel#

Cancel a run.

Argument Type Required Description
RUN_ID str yes Run id (see 'runs list').
Option Type Default Description
--reason str Why the run is being cancelled.

tendrl-cli strand runs approve#

Approve a paused approval step.

Argument Type Required Description
RUN_ID str yes Run id (see 'runs list').
STEP_RUN_ID str yes Step run id (see 'runs steps').
Option Type Default Description
--comment str Note for the audit trail.

tendrl-cli strand runs reject#

Reject a paused approval step.

Argument Type Required Description
RUN_ID str yes Run id (see 'runs list').
STEP_RUN_ID str yes Step run id (see 'runs steps').
Option Type Default Description
--comment str Note for the audit trail.

tendrl-cli strand connectors list#

List connectors.

Option Type Default Description
--type str Filter by connector type.
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli strand connectors get#

Show one connector.

Argument Type Required Description
CONNECTOR_ID str yes Connector id (see 'connectors list').

tendrl-cli strand connectors create#

Create a connector.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli strand connectors delete#

Delete a connector.

Argument Type Required Description
CONNECTOR_ID str yes Connector id (see 'connectors list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli strand connectors test#

Test a connector configuration.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli strand connectors types#

List available connector types.

tendrl-cli strand connectors ai-models#

List available AI models by provider.

tendrl-cli strand functions list#

List functions.

tendrl-cli strand functions get#

Show one function.

Argument Type Required Description
FUNCTION_ID str yes Function id (see 'functions list').

tendrl-cli strand functions create#

Create a function.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli strand functions delete#

Delete a function.

Argument Type Required Description
FUNCTION_ID str yes Function id (see 'functions list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli strand functions test#

Run a function against a test payload.

Argument Type Required Description
FUNCTION_ID str no Saved function to test (omit with --code-file).
Option Type Default Description
--data, -d str Test payload JSON (default {}).
--file, -f path Read the JSON body from a file.
--code-file path Test unsaved code from a local file.

tendrl-cli strand vault list#

List secrets.

tendrl-cli strand vault set#

Store a secret.

Argument Type Required Description
KEY str yes Secret key name.
VALUE str no Secret value (prompted if omitted).
Option Type Default Description
--description str What this secret is for.

tendrl-cli strand vault delete#

Delete a secret.

Argument Type Required Description
VAULT_ID str yes Secret id (see 'vault list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli strand configurations list#

List configurations.

Option Type Default Description
--type str Filter by configuration type.

tendrl-cli strand configurations get#

Show one configuration.

Argument Type Required Description
CONFIGURATION_ID str yes Configuration id (see 'configurations list').

tendrl-cli strand configurations create#

Create a configuration.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli strand configurations delete#

Delete a configuration.

Argument Type Required Description
CONFIGURATION_ID str yes Configuration id (see 'configurations list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli strand templates list#

List templates.

Option Type Default Description
--category str Filter by template category.
--tag str Filter by template tag.

tendrl-cli strand templates get#

Show one template.

Argument Type Required Description
TEMPLATE_ID str yes Template id (see 'templates list').

tendrl-cli strand templates readiness#

Check what a template needs before it can run for you.

Argument Type Required Description
TEMPLATE_ID str yes Template id (see 'templates list').

tendrl-cli strand templates use#

Create a workflow from a template.

Argument Type Required Description
TEMPLATE_ID str yes Template id (see 'templates list').
Option Type Default Description
--name str Name for the new workflow.

tendrl-cli strand keys list#

List API keys.

tendrl-cli strand keys create#

Create an API key (token shown once — save it).

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli strand keys rotate#

Rotate an API key (new token shown once).

Argument Type Required Description
KEY_ID str yes API key id (see 'keys list').

tendrl-cli strand keys delete#

Delete an API key.

Argument Type Required Description
KEY_ID str yes API key id (see 'keys list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli strand team list#

List team members.

tendrl-cli strand team invite#

Invite a team member.

Argument Type Required Description
EMAIL str yes Email address to invite.
Option Type Default Description
--role str Viewer Role name or id (see 'strand roles list').

tendrl-cli strand team set-role#

Change a member's role.

Argument Type Required Description
USER_ID str yes User id (see 'users list' / 'team list').
ROLE str yes Role name or id.

tendrl-cli strand team remove#

Remove a team member.

Argument Type Required Description
USER_ID str yes User id (see 'users list' / 'team list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli strand roles list#

List roles.

tendrl-cli strand roles get#

Show one role.

Argument Type Required Description
ROLE_ID str yes Role name.

tendrl-cli strand roles permissions#

List all assignable permissions.

tendrl-cli strand usage current#

Usage this billing period.

tendrl-cli strand usage history#

Usage history.

tendrl-cli strand usage breakdown#

Usage broken down by workflow.

tendrl-cli strand usage summary#

Usage summary.

surface#

Surface — file and payload scanning.

tendrl-cli surface scan file#

Scan a local file — hosted, or on a local scanner daemon with --local.

Argument Type Required Description
PATH path yes File to scan.
Option Type Default Description
--profile str Scan profile name or id (hosted only).
--local, -l flag Use a local surface-scanner daemon instead of the hosted API (SURFACE_SCANNER_URL or 'config set-scanner'; default http://127.0.0.1:8080).

tendrl-cli surface scan payload#

Scan an inline payload (JSON body).

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.
--local, -l flag Use a local surface-scanner daemon instead of the hosted API (SURFACE_SCANNER_URL or 'config set-scanner'; default http://127.0.0.1:8080).

tendrl-cli surface scan get#

Show a scan's result.

Argument Type Required Description
SCAN_ID str yes Scan id (the requestId from a scan or history entry).
Option Type Default Description
--local, -l flag Use a local surface-scanner daemon instead of the hosted API (SURFACE_SCANNER_URL or 'config set-scanner'; default http://127.0.0.1:8080).

tendrl-cli surface history list#

List past scans.

Option Type Default Description
--limit, -n int 25 Max rows to return.
--offset int 0 Rows to skip (paging).

tendrl-cli surface history get#

Show one history entry.

Argument Type Required Description
SCAN_ID str yes Scan id (the requestId from a scan or history entry).

tendrl-cli surface history export#

Export a scan report.

Argument Type Required Description
SCAN_ID str yes Scan id (the requestId from a scan or history entry).
Option Type Default Description
--out, -o path Output file.

tendrl-cli surface account show#

Show account details and plan.

tendrl-cli surface account usage#

Show scan usage against your plan.

tendrl-cli surface account analytics#

Show detection analytics.

tendrl-cli surface account blocked-ips#

List blocked IPs.

tendrl-cli surface profiles list#

List scan profiles.

tendrl-cli surface profiles get#

Show one profile.

Argument Type Required Description
PROFILE_ID str yes Profile id (see 'profiles list').

tendrl-cli surface profiles create#

Create a scan profile.

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli surface profiles update#

Update a scan profile.

Argument Type Required Description
PROFILE_ID str yes Profile id (see 'profiles list').
Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli surface profiles delete#

Delete a scan profile.

Argument Type Required Description
PROFILE_ID str yes Profile id (see 'profiles list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

tendrl-cli surface profiles test-webhook#

Send a test event to a profile's webhook.

Argument Type Required Description
PROFILE_ID str yes Profile id (see 'profiles list').

tendrl-cli surface keys list#

List API keys.

tendrl-cli surface keys create#

Create an API key (secret shown once — save it).

Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.

tendrl-cli surface keys delete#

Delete an API key.

Argument Type Required Description
KEY_ID str yes API key id (see 'keys list').
Option Type Default Description
--yes, -y flag Skip the confirmation prompt.

config#

Local CLI configuration (~/.config/tendrl/config.json).

tendrl-cli config path#

Print the config file path.

tendrl-cli config show#

Show the current configuration (secrets masked).

tendrl-cli config set-scanner#

Set the local scanner daemon URL used by 'surface scan --local'.

Argument Type Required Description
URL str yes Local surface-scanner daemon URL, e.g. http://127.0.0.1:8080

tendrl-cli config set-url#

Set the platform URL the CLI talks to.

Argument Type Required Description
URL str yes Platform origin, e.g. https://app.tendrl.com

tendrl-cli config set-key#

Store an API key for a service.

Argument Type Required Description
SERVICE str yes contact, strand, or surface.
KEY str no API key (prompted if omitted).

tendrl-cli config unset-key#

Remove a stored API key.

Argument Type Required Description
SERVICE str yes contact, strand, or surface.

api#

tendrl-cli api#

Call any Tendrl API endpoint directly (uses your API key).

Argument Type Required Description
SERVICE str yes contact, strand, or surface.
METHOD str yes GET, POST, PUT, PATCH, or DELETE.
PATH str yes Endpoint path, e.g. /entities.
Option Type Default Description
--data, -d str JSON body, or '-' to read stdin.
--file, -f path Read the JSON body from a file.
--param, -q str Query param, key=value (repeatable).

← Back to Contact docs