The thinger command-line interface works with a Thinger.io server from your terminal: devices, products, Data Buckets and dashboard apps. It also runs an MCP server, so an AI client can use your account through the CLI's sign-in. The command reference on this page is generated from the CLI itself.
| Package | Installed from | Version | Source code |
|---|---|---|---|
@thinger-io/cli | npm | 0.5.1 | thinger-io/thinger-cli |
@thinger-io/cli-core | npm | 0.5.2 | thinger-io/thinger-cli-core |
- Install: Install, on this page (
@thinger-io/cli-corecomes with it). To use its MCP server from an AI client, follow Connect an AI agent. - Changelog: CLI changelog: every release, with what it adds, changes and fixes.
Versions 0.x
While the CLI is in 0.x versions, commands and options can still change between minor versions. Check the changelog before you upgrade scripts that depend on it.
Install
The CLI needs Node.js 20 or later. Install it globally from npm:
npm install -g @thinger-io/cliCheck the installed version:
thinger --versionYou can also run any command without installing it, with npx -y @thinger-io/cli <command>.
Sign in
thinger login signs in to a server and stores the session in a profile. Without options it asks for the sign-in method and the server. YOUR_SERVER is iot.thinger.io on the free Cloud account, or your own domain on a private instance. A bare host means HTTPS; give a full URL (http://… or a custom port) for anything else.
| Method | How | What the profile keeps |
|---|---|---|
| OAuth (browser) | thinger login, then choose OAuth (browser), or thinger login --oauth. The CLI shows a link and a code; you approve the access in the browser, signed in to your server (OAuth device flow). | An OAuth session with full access to your account, renewed on its own while you use it. |
| Token | thinger login --server YOUR_SERVER --username YOUR_USER --token YOUR_TOKEN. Works without a terminal, for scripts and CI. | The access token you gave. Here YOUR_TOKEN is an access token of your account. |
| Username and password | thinger login, then choose Username and password. The password is always asked interactively. | An access token named Thinger CLI, created in your account with full permissions. thinger logout revokes it. |
The browser sign-in uses the Thinger CLI OAuth client, which every server creates for it (see OAuth2 Clients). When the server does not have it, the CLI says so and offers username and password or a token instead. --client-id <id> signs in through another OAuth client registered on the server.
When a profile is active, thinger login signs in again on that same profile. To add another server, use thinger profile add.
thinger logout forgets the current profile and revokes the token the CLI created at sign-in; --keep-token keeps it on the server, and --all forgets every profile.
Self-signed certificates are accepted only for localhost and 127.0.0.1, or when THINGER_INSECURE=1 is set.
Profiles
A profile is one server and one account. Use profiles to work with several servers or accounts:
thinger profile add staging --server YOUR_SERVER --username YOUR_USER --token YOUR_TOKEN
thinger profile list
thinger profile use staging
thinger device list --profile productionThe CLI picks the profile in this order:
- The
--profile <name>option of the command. - The
THINGER_PROFILEenvironment variable. THINGER_TOKENandTHINGER_SERVER, when both are set (see Environment variables).- The default profile, set with
thinger profile use. The first profile you create becomes the default.
Environment variables
| Variable | Effect |
|---|---|
THINGER_TOKEN | Access token to use instead of the saved profiles. Set it together with THINGER_SERVER. The token must be a JWT access token: the CLI reads the username from it. |
THINGER_SERVER | Server for THINGER_TOKEN: a host, or a URL for HTTP or a custom port. Setting THINGER_TOKEN without it is an error. |
THINGER_PROFILE | Profile to use when the command has no --profile. |
THINGER_INSECURE | Set it to 1 to accept self-signed certificates on any host. Any other value is ignored. |
THINGER_TOKEN and THINGER_SERVER take precedence over the saved default profile, but not over a profile you name with --profile or THINGER_PROFILE. They are the usual way to run the CLI in CI:
THINGER_SERVER=YOUR_SERVER THINGER_TOKEN=YOUR_TOKEN thinger device list --jsonJSON output
Commands that take -j, --json print a JSON envelope on standard output instead of tables and messages, so scripts and agents can parse the result. login, logout and mcp do not take it.
On success, data holds the result. For example, thinger device set-product YOUR_DEVICE "" --json (which removes the device from its product) prints:
{
"ok": true,
"data": { "device": "YOUR_DEVICE", "product": null }
}On failure, the envelope carries the error message and a code:
{
"ok": false,
"error": {
"message": "Unauthorized. Your token may have expired. Please reconfigure.",
"code": "unauthorized"
}
}code | Meaning |
|---|---|
unauthorized | The token is missing, expired or not valid for the server (HTTP 401), or it is not allowed to do this (HTTP 403, Forbidden). |
not_found | The device, product, bucket or other resource does not exist. |
already_exists | A resource with that ID already exists. |
input_error | An argument or option is not valid. |
not_configured | There is no profile: run thinger login. |
needs_confirm | A destructive command needs --yes in JSON mode or when there is no terminal to confirm it. |
server_error | The server answered with an error. |
network_error | The server could not be reached. |
timeout | The server did not answer in time. |
error | Any other error. |
The exit status is 0 on success and 1 on error.
Configuration file
Profiles are stored in ~/.config/thinger-cli/config.json in your home folder, on macOS, Linux and Windows alike. The folder is readable only by your user and the file is written with owner-only permissions, because it contains access tokens. Do not share it or commit it.
Global options
These options work with every command:
thinger [options] [command]| Option | Description |
|---|---|
-V, --version | output the version number |
-u, --user <username> | API user override (admin impersonation) |
--profile <name> | Configuration profile to use (defaults to the saved default) |
-h, --help | Display help for the command. |
Add --help to any command or group to print its usage, for example thinger dashboard publish --help.
Commands
| Command | Description |
|---|---|
thinger device | Devices: records, properties, resources, data and their children |
thinger product | Products: records, properties, profile and their export |
thinger bucket | Data buckets: records, time series, exports and tags |
thinger dashboard | Dashboards: apps on the dashboard SDK (create, develop and publish them) and their records |
thinger storage | File storages; their files are type storage_file |
thinger plugin | Plugins installed on the account: containers that add features (integrations, apps); their API is reached with thinger plugin call |
thinger endpoint | Endpoints: outgoing HTTP calls, emails, notifications (run one with its call action) |
thinger asset | Assets: types and groups that organize devices |
thinger project | Projects: group resources of any type to share them or show them together |
thinger token | Access tokens of the account, with their permission tree |
thinger alarm | Alarms: the rules that watch devices and buckets, and the instances they raise |
thinger claim | Device claims: codes that let end users take ownership of a device |
thinger property | Account properties: JSON values stored on the account |
thinger role | Roles: named permission sets for project members |
thinger sync | Syncs: shared semaphores with a number of slots that devices or scripts take (locks) to coordinate |
thinger admin | Server administration (admin accounts): users, hosts, domains, brands… |
thinger login | Sign in: re-authenticate the current profile, or create the first one. Use profile add for more servers. |
thinger logout | Forget the current profile (or --all) and revoke the API token the CLI created |
thinger profile | Manage configuration profiles |
thinger api | Send a request to the server API (anything the commands do not cover) |
thinger doc | Guides for agents and app developers: the platform, product code, the dashboard SDK, this CLI |
thinger mcp | Start the MCP server (stdio) for AI tool integration |
thinger device
Devices: records, properties, resources, data and their children
thinger device [options] [command]| Command | Description |
|---|---|
thinger device list | List devices: online state, id, name, type and product |
thinger device get | Show a device as JSON |
thinger device create | Register a device; Generic/MQTT ones get random credentials unless given |
thinger device update | Update fields of a device (fields left out are kept) |
thinger device delete | Delete a device record from the platform (irreversible) |
thinger device clone | Copy a device under a new id |
thinger device describe | Fields, examples and permissions of a device, from the server's API |
thinger device send | Send data as an HTTP device would: the server runs the device's callback |
thinger device overview | Usage of all the devices over the last 30 days, per day |
thinger device set-product | Assign a device to a product ("" to unassign) |
thinger device stats | Usage over the last 30 days, per day: traffic and calls (empty when the server does not record usage) |
thinger device resource | Resources of a connected device: its firmware's API and its product's |
thinger device property | Properties of a device: its structured state (configuration, calibration…) |
thinger device token | Tokens scoped to one device and some of its resources |
thinger device bucket | Buckets that hold data of a device (read-only listing) |
thinger device service | Services a device exposes (web, VNC…) |
thinger device callback | HTTP callback settings of a device: what the server does with the data it receives |
thinger device list
List devices: online state, id, name, type and product
thinger device list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger device get
Show a device as JSON
thinger device get [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger device create
Register a device; Generic/MQTT ones get random credentials unless given
thinger device create [options] [device]| Argument | Required | Description |
|---|---|---|
device | No | Device ID |
| Option | Description |
|---|---|
-t, --type <type> | Device type: Generic, MQTT, HTTP, Virtual, Subdevice (default: Generic) |
-c, --credentials <credentials> | Device credentials (6+ characters) |
-n, --name <name> | Display name |
-d, --description <text> | Description |
-p, --product <product> | Assign to a product |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
-j, --json | Output as JSON |
thinger device update
Update fields of a device (fields left out are kept)
thinger device update [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger device delete
Delete a device record from the platform (irreversible)
thinger device delete [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | Device ID |
| Option | Description |
|---|---|
-y, --yes | Skip the interactive confirmation prompt |
-j, --json | Output as JSON |
thinger device clone
Copy a device under a new id
thinger device clone [options] <device> <new-id>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger device describe
Fields, examples and permissions of a device, from the server's API
thinger device describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device send
Send data as an HTTP device would: the server runs the device's callback
thinger device send [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | Device ID |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-j, --json | Output as JSON |
thinger device overview
Usage of all the devices over the last 30 days, per day
thinger device overview [options]| Option | Description |
|---|---|
--locations | Also the last known position of each connected device |
-j, --json | Output as JSON |
thinger device set-product
Assign a device to a product ("" to unassign)
thinger device set-product [options] <device> <product>| Argument | Required | Description |
|---|---|---|
device | Yes | Device ID |
product | Yes | Product ID ("" removes the device from its product) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device stats
Usage over the last 30 days, per day: traffic and calls (empty when the server does not record usage)
thinger device stats [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
thinger device resource
Resources of a connected device: its firmware's API and its product's
thinger device resource [options] [command]| Command | Description |
|---|---|
thinger device resource list | List the resources a connected device exposes, with their inputs and outputs |
thinger device resource call | Call a resource of a connected device: with --from or --set it runs it with that input; without, it reads its output |
thinger device resource list
List the resources a connected device exposes, with their inputs and outputs
thinger device resource list [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | Device ID |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device resource call
Call a resource of a connected device: with --from or --set it runs it with that input; without, it reads its output
thinger device resource call [options] <device> <resource>| Argument | Required | Description |
|---|---|---|
device | Yes | Device ID |
resource | Yes | Resource of the device to call |
| Option | Description |
|---|---|
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-j, --json | Output as JSON |
thinger device property
Properties of a device: its structured state (configuration, calibration…)
thinger device property [options] [command]| Command | Description |
|---|---|
thinger device property list | List device property records |
thinger device property get | Show a device property as JSON |
thinger device property create | Create a device property from --from and --set |
thinger device property update | Update fields of a device property (fields left out are kept) |
thinger device property delete | Delete a device property |
thinger device property clone | Copy a device property under a new id |
thinger device property set | Set the value of a device property (created when missing) |
thinger device property describe | Fields, examples and permissions of a device property, from the server's API |
thinger device property list
List device property records
thinger device property list [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger device property get
Show a device property as JSON
thinger device property get [options] <device> <property>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
property | Yes | ID of the device property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger device property create
Create a device property from --from and --set
thinger device property create [options] <device> [property]| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
property | No | ID of the device property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger device property update
Update fields of a device property (fields left out are kept)
thinger device property update [options] <device> <property>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
property | Yes | ID of the device property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--merge | Patch the value (JSON merge) instead of replacing it |
thinger device property delete
Delete a device property
thinger device property delete [options] <device> <property>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
property | Yes | ID of the device property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger device property clone
Copy a device property under a new id
thinger device property clone [options] <device> <property> <new-id>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
property | Yes | ID of the device property |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger device property set
Set the value of a device property (created when missing)
thinger device property set [options] <device> <property> <value>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
property | Yes | ID of the device property |
value | Yes | Value, parsed as JSON (text when it is not JSON) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device property describe
Fields, examples and permissions of a device property, from the server's API
thinger device property describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device token
Tokens scoped to one device and some of its resources
thinger device token [options] [command]| Command | Description |
|---|---|
thinger device token list | List device token records |
thinger device token create | Create a device token from --from and --set |
thinger device token delete | Delete a device token |
thinger device token describe | Fields, examples and permissions of a device token, from the server's API |
thinger device token list
List device token records
thinger device token list [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger device token create
Create a device token from --from and --set
thinger device token create [options] <device> [token]| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
token | No | ID of the device token |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger device token delete
Delete a device token
thinger device token delete [options] <device> <token>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
token | Yes | ID of the device token |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger device token describe
Fields, examples and permissions of a device token, from the server's API
thinger device token describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device bucket
Buckets that hold data of a device (read-only listing)
thinger device bucket [options] [command]| Command | Description |
|---|---|
thinger device bucket list | List device bucket records |
thinger device bucket describe | Fields, examples and permissions of a device bucket, from the server's API |
thinger device bucket tag | Tags of a device bucket |
thinger device bucket list
List device bucket records
thinger device bucket list [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger device bucket describe
Fields, examples and permissions of a device bucket, from the server's API
thinger device bucket describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device bucket tag
Tags of a device bucket
thinger device bucket tag [options] [command]| Command | Description |
|---|---|
thinger device bucket tag list | List device bucket tag records |
thinger device bucket tag get | Show a device bucket tag as JSON |
thinger device bucket tag describe | Fields, examples and permissions of a device bucket tag, from the server's API |
thinger device bucket tag list
List device bucket tag records
thinger device bucket tag list [options] <device> <bucket>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
bucket | Yes | ID of the device bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger device bucket tag get
Show a device bucket tag as JSON
thinger device bucket tag get [options] <device> <bucket> <tag>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
bucket | Yes | ID of the device bucket |
tag | Yes | ID of the device bucket tag |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger device bucket tag describe
Fields, examples and permissions of a device bucket tag, from the server's API
thinger device bucket tag describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device service
Services a device exposes (web, VNC…)
thinger device service [options] [command]| Command | Description |
|---|---|
thinger device service list | List device service records |
thinger device service get | Show a device service as JSON |
thinger device service describe | Fields, examples and permissions of a device service, from the server's API |
thinger device service list
List device service records
thinger device service list [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger device service get
Show a device service as JSON
thinger device service get [options] <device> <service>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
service | Yes | ID of the device service |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger device service describe
Fields, examples and permissions of a device service, from the server's API
thinger device service describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger device callback
HTTP callback settings of a device: what the server does with the data it receives
thinger device callback [options] [command]| Command | Description |
|---|---|
thinger device callback get | Show a device callback as JSON |
thinger device callback update | Update fields of a device callback (fields left out are kept) |
thinger device callback describe | Fields, examples and permissions of a device callback, from the server's API |
thinger device callback get
Show a device callback as JSON
thinger device callback get [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger device callback update
Update fields of a device callback (fields left out are kept)
thinger device callback update [options] <device>| Argument | Required | Description |
|---|---|---|
device | Yes | ID of the device |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger device callback describe
Fields, examples and permissions of a device callback, from the server's API
thinger device callback describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product
Products: records, properties, profile and their export
thinger product [options] [command]| Command | Description |
|---|---|
thinger product list | List the products of the account, with their API resources |
thinger product get | Show a product as JSON |
thinger product create | Create a product, bare or from a JSON document (config + profile); the CLI template fills in the rest |
thinger product update | Update fields of a product (fields left out are kept) |
thinger product delete | Delete a product (its devices stay, unassigned) |
thinger product clone | Copy a product under a new id |
thinger product describe | Fields, examples and permissions of a product, from the server's API |
thinger product export | The product with what it depends on, as one JSON document, to back it up or recreate it |
thinger product apply | Create or update a product from the JSON product export writes (profile and properties included) |
thinger product profile | Profile of a product: the API resources, buckets, properties, autoprovisioning, flows and code its devices get |
thinger product property | Properties of a product |
thinger product service | Services a product exposes on its devices |
thinger product list
List the products of the account, with their API resources
thinger product list [options]| Option | Description | Default |
|---|---|---|
-j, --json | Output as JSON | |
-c, --concurrency <n> | Max parallel API-resource lookups (default: 10) | 10 |
--search <text> | Text to look for in ids and names | |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records | |
--count <n> | Page size (default: all) | |
--index <n> | Offset of the first record |
thinger product get
Show a product as JSON
thinger product get [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product create
Create a product, bare or from a JSON document (config + profile); the CLI template fills in the rest
thinger product create [options] [product]| Argument | Required | Description |
|---|---|---|
product | No | Product ID |
| Option | Description |
|---|---|
-n, --name <name> | Display name |
-d, --description <text> | Description |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
-j, --json | Output as JSON |
thinger product update
Update fields of a product (fields left out are kept)
thinger product update [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger product delete
Delete a product (its devices stay, unassigned)
thinger product delete [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | Product ID |
| Option | Description |
|---|---|
-y, --yes | Skip the interactive confirmation prompt |
-j, --json | Output as JSON |
thinger product clone
Copy a product under a new id
thinger product clone [options] <product> <new-id>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product describe
Fields, examples and permissions of a product, from the server's API
thinger product describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product export
The product with what it depends on, as one JSON document, to back it up or recreate it
thinger product export [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
thinger product apply
Create or update a product from the JSON product export writes (profile and properties included)
thinger product apply [options]| Option | Description |
|---|---|
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-j, --json | Output as JSON |
thinger product profile
Profile of a product: the API resources, buckets, properties, autoprovisioning, flows and code its devices get
thinger product profile [options] [command]| Command | Description |
|---|---|
thinger product profile api | API resources a product adds to its devices (calls to device resources, endpoints, scripts) |
thinger product profile bucket | Buckets a product keeps for each of its devices |
thinger product profile property | Properties a product creates on each of its devices |
thinger product profile autoprovision | Autoprovisioning rules: which connecting devices join the product |
thinger product profile flow | Data flows of a product: periodic reads of device resources |
thinger product profile code | Script code of a product (JavaScript run by the server for its devices) |
thinger product profile api
API resources a product adds to its devices (calls to device resources, endpoints, scripts)
thinger product profile api [options] [command]| Command | Description |
|---|---|
thinger product profile api list | List product profile api records |
thinger product profile api get | Show a product profile api as JSON |
thinger product profile api create | Create a product profile api from --from and --set |
thinger product profile api update | Update fields of a product profile api (fields left out are kept) |
thinger product profile api delete | Delete a product profile api |
thinger product profile api describe | Fields, examples and permissions of a product profile api, from the server's API |
thinger product profile api call | Call a product API resource for the whole product (needs its device_id_resolver) |
thinger product profile api replace-all | Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept |
thinger product profile api list
List product profile api records
thinger product profile api list [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger product profile api get
Show a product profile api as JSON
thinger product profile api get [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile api |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product profile api create
Create a product profile api from --from and --set
thinger product profile api create [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile api |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile api update
Update fields of a product profile api (fields left out are kept)
thinger product profile api update [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile api |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile api delete
Delete a product profile api
thinger product profile api delete [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile api |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger product profile api describe
Fields, examples and permissions of a product profile api, from the server's API
thinger product profile api describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product profile api call
Call a product API resource for the whole product (needs its device_id_resolver)
thinger product profile api call [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | Product ID |
resource | Yes | API resource of the product profile |
| Option | Description |
|---|---|
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-j, --json | Output as JSON |
thinger product profile api replace-all
Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept
thinger product profile api replace-all [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-y, --yes | Do not ask for confirmation |
thinger product profile bucket
Buckets a product keeps for each of its devices
thinger product profile bucket [options] [command]| Command | Description |
|---|---|
thinger product profile bucket list | List product profile bucket records |
thinger product profile bucket get | Show a product profile bucket as JSON |
thinger product profile bucket create | Create a product profile bucket from --from and --set |
thinger product profile bucket update | Update fields of a product profile bucket (fields left out are kept) |
thinger product profile bucket delete | Delete a product profile bucket |
thinger product profile bucket describe | Fields, examples and permissions of a product profile bucket, from the server's API |
thinger product profile bucket replace-all | Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept |
thinger product profile bucket list
List product profile bucket records
thinger product profile bucket list [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger product profile bucket get
Show a product profile bucket as JSON
thinger product profile bucket get [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product profile bucket create
Create a product profile bucket from --from and --set
thinger product profile bucket create [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile bucket update
Update fields of a product profile bucket (fields left out are kept)
thinger product profile bucket update [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile bucket delete
Delete a product profile bucket
thinger product profile bucket delete [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger product profile bucket describe
Fields, examples and permissions of a product profile bucket, from the server's API
thinger product profile bucket describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product profile bucket replace-all
Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept
thinger product profile bucket replace-all [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-y, --yes | Do not ask for confirmation |
thinger product profile property
Properties a product creates on each of its devices
thinger product profile property [options] [command]| Command | Description |
|---|---|
thinger product profile property list | List product profile property records |
thinger product profile property get | Show a product profile property as JSON |
thinger product profile property create | Create a product profile property from --from and --set |
thinger product profile property update | Update fields of a product profile property (fields left out are kept) |
thinger product profile property delete | Delete a product profile property |
thinger product profile property describe | Fields, examples and permissions of a product profile property, from the server's API |
thinger product profile property replace-all | Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept |
thinger product profile property list
List product profile property records
thinger product profile property list [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger product profile property get
Show a product profile property as JSON
thinger product profile property get [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product profile property create
Create a product profile property from --from and --set
thinger product profile property create [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile property update
Update fields of a product profile property (fields left out are kept)
thinger product profile property update [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile property delete
Delete a product profile property
thinger product profile property delete [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger product profile property describe
Fields, examples and permissions of a product profile property, from the server's API
thinger product profile property describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product profile property replace-all
Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept
thinger product profile property replace-all [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-y, --yes | Do not ask for confirmation |
thinger product profile autoprovision
Autoprovisioning rules: which connecting devices join the product
thinger product profile autoprovision [options] [command]| Command | Description |
|---|---|
thinger product profile autoprovision list | List product profile autoprovision records |
thinger product profile autoprovision get | Show a product profile autoprovision as JSON |
thinger product profile autoprovision create | Create a product profile autoprovision from --from and --set |
thinger product profile autoprovision update | Update fields of a product profile autoprovision (fields left out are kept) |
thinger product profile autoprovision delete | Delete a product profile autoprovision |
thinger product profile autoprovision describe | Fields, examples and permissions of a product profile autoprovision, from the server's API |
thinger product profile autoprovision replace-all | Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept |
thinger product profile autoprovision list
List product profile autoprovision records
thinger product profile autoprovision list [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger product profile autoprovision get
Show a product profile autoprovision as JSON
thinger product profile autoprovision get [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile autoprovision |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product profile autoprovision create
Create a product profile autoprovision from --from and --set
thinger product profile autoprovision create [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile autoprovision |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile autoprovision update
Update fields of a product profile autoprovision (fields left out are kept)
thinger product profile autoprovision update [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile autoprovision |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile autoprovision delete
Delete a product profile autoprovision
thinger product profile autoprovision delete [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile autoprovision |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger product profile autoprovision describe
Fields, examples and permissions of a product profile autoprovision, from the server's API
thinger product profile autoprovision describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product profile autoprovision replace-all
Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept
thinger product profile autoprovision replace-all [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-y, --yes | Do not ask for confirmation |
thinger product profile flow
Data flows of a product: periodic reads of device resources
thinger product profile flow [options] [command]| Command | Description |
|---|---|
thinger product profile flow list | List product profile flow records |
thinger product profile flow get | Show a product profile flow as JSON |
thinger product profile flow create | Create a product profile flow from --from and --set |
thinger product profile flow update | Update fields of a product profile flow (fields left out are kept) |
thinger product profile flow delete | Delete a product profile flow |
thinger product profile flow describe | Fields, examples and permissions of a product profile flow, from the server's API |
thinger product profile flow replace-all | Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept |
thinger product profile flow list
List product profile flow records
thinger product profile flow list [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger product profile flow get
Show a product profile flow as JSON
thinger product profile flow get [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile flow |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product profile flow create
Create a product profile flow from --from and --set
thinger product profile flow create [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile flow |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile flow update
Update fields of a product profile flow (fields left out are kept)
thinger product profile flow update [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile flow |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile flow delete
Delete a product profile flow
thinger product profile flow delete [options] <product> <resource>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
resource | Yes | ID of the product profile flow |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger product profile flow describe
Fields, examples and permissions of a product profile flow, from the server's API
thinger product profile flow describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product profile flow replace-all
Replace every entry of this profile category at once with the body ({id: entry, …}). The only way to use ids with placeholders such as {{device}}_data, which the per-entry path does not accept
thinger product profile flow replace-all [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-y, --yes | Do not ask for confirmation |
thinger product profile code
Script code of a product (JavaScript run by the server for its devices)
thinger product profile code [options] [command]| Command | Description |
|---|---|
thinger product profile code get | Show a product profile code as JSON |
thinger product profile code update | Update fields of a product profile code (fields left out are kept) |
thinger product profile code describe | Fields, examples and permissions of a product profile code, from the server's API |
thinger product profile code get
Show a product profile code as JSON
thinger product profile code get [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product profile code update
Update fields of a product profile code (fields left out are kept)
thinger product profile code update [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product profile code describe
Fields, examples and permissions of a product profile code, from the server's API
thinger product profile code describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product property
Properties of a product
thinger product property [options] [command]| Command | Description |
|---|---|
thinger product property list | List product property records |
thinger product property get | Show a product property as JSON |
thinger product property create | Create a product property from --from and --set |
thinger product property update | Update fields of a product property (fields left out are kept) |
thinger product property delete | Delete a product property |
thinger product property clone | Copy a product property under a new id |
thinger product property set | Set the value of a product property (created when missing) |
thinger product property describe | Fields, examples and permissions of a product property, from the server's API |
thinger product property list
List product property records
thinger product property list [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger product property get
Show a product property as JSON
thinger product property get [options] <product> <property>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
property | Yes | ID of the product property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product property create
Create a product property from --from and --set
thinger product property create [options] <product> [property]| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
property | No | ID of the product property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product property update
Update fields of a product property (fields left out are kept)
thinger product property update [options] <product> <property>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
property | Yes | ID of the product property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--merge | Patch the value (JSON merge) instead of replacing it |
thinger product property delete
Delete a product property
thinger product property delete [options] <product> <property>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
property | Yes | ID of the product property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger product property clone
Copy a product property under a new id
thinger product property clone [options] <product> <property> <new-id>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
property | Yes | ID of the product property |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product property set
Set the value of a product property (created when missing)
thinger product property set [options] <product> <property> <value>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
property | Yes | ID of the product property |
value | Yes | Value, parsed as JSON (text when it is not JSON) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product property describe
Fields, examples and permissions of a product property, from the server's API
thinger product property describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger product service
Services a product exposes on its devices
thinger product service [options] [command]| Command | Description |
|---|---|
thinger product service list | List product service records |
thinger product service get | Show a product service as JSON |
thinger product service create | Create a product service from --from and --set |
thinger product service update | Update fields of a product service (fields left out are kept) |
thinger product service delete | Delete a product service |
thinger product service describe | Fields, examples and permissions of a product service, from the server's API |
thinger product service list
List product service records
thinger product service list [options] <product>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger product service get
Show a product service as JSON
thinger product service get [options] <product> <service>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
service | Yes | ID of the product service |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger product service create
Create a product service from --from and --set
thinger product service create [options] <product> <service>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
service | Yes | ID of the product service |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product service update
Update fields of a product service (fields left out are kept)
thinger product service update [options] <product> <service>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
service | Yes | ID of the product service |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger product service delete
Delete a product service
thinger product service delete [options] <product> <service>| Argument | Required | Description |
|---|---|---|
product | Yes | ID of the product |
service | Yes | ID of the product service |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger product service describe
Fields, examples and permissions of a product service, from the server's API
thinger product service describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger bucket
Data buckets: records, time series, exports and tags
thinger bucket [options] [command]| Command | Description |
|---|---|
thinger bucket list | List the data buckets of the account |
thinger bucket get | Show a bucket as JSON |
thinger bucket create | Create a bucket from --from and --set |
thinger bucket update | Update fields of a bucket (fields left out are kept) |
thinger bucket delete | Delete a bucket |
thinger bucket clone | Copy a bucket under a new id |
thinger bucket describe | Fields, examples and permissions of a bucket, from the server's API |
thinger bucket read | Read samples from a bucket (latest first by default) |
thinger bucket write | Write samples: one JSON object, an array of them with their ts (unix ms), or NDJSON |
thinger bucket export | Export the data of a bucket to a file (or stdout) and download it |
thinger bucket import | Load records from a .csv already in a file storage (upload it with thinger storage file upload) into an existing bucket: body {source: "storage", storage, file}. Header row; ";" separated if the header has one, "," otherwise. The time column (ts, date or timestamp) takes unix MILLISECONDS (seconds are misread as ms) or ISO 8601, always taken as UTC. Other cells become numbers when they parse, text otherwise; empty and "null" are left out. Columns named like a bucket tag (config.tags) are stored as that tag: a device column in a bucket tagged device (product buckets are) makes the records readable per device. Writes straight to the backend (MongoDB or InfluxDB, not DynamoDB), with no rate limit and no bucket_write events; answers {"progress": N}, a percentage (100 when done; only the last line is shown). The way to load history in bulk: thinger bucket write is rate limited |
thinger bucket tag | Tags of a bucket and their values |
thinger bucket export-file | Exports of a bucket (files generated from its data) |
thinger bucket list
List the data buckets of the account
thinger bucket list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger bucket get
Show a bucket as JSON
thinger bucket get [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger bucket create
Create a bucket from --from and --set
thinger bucket create [options] [bucket]| Argument | Required | Description |
|---|---|---|
bucket | No | ID of the bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger bucket update
Update fields of a bucket (fields left out are kept)
thinger bucket update [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger bucket delete
Delete a bucket
thinger bucket delete [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger bucket clone
Copy a bucket under a new id
thinger bucket clone [options] <bucket> <new-id>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger bucket describe
Fields, examples and permissions of a bucket, from the server's API
thinger bucket describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger bucket read
Read samples from a bucket (latest first by default)
thinger bucket read [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | Data Bucket ID |
| Option | Description | Default |
|---|---|---|
-d, --device <device> | Series a product bucket keeps for this device | |
-n, --items <n> | Number of samples | 10 |
-m, --minutes <n> | Only the last N minutes | |
--sort <order> | asc or desc | desc |
--agg <window> | Aggregation window, e.g. 5m, 1h | |
--agg-type <reducer> | Reducer: mean, max, min, sum, count, first, last… | |
--fields <list> | Comma-separated fields to return | |
--group-by <key> | Group key, e.g. device | |
-j, --json | Output as JSON |
thinger bucket write
Write samples: one JSON object, an array of them with their ts (unix ms), or NDJSON
thinger bucket write [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | Data Bucket ID |
| Option | Description |
|---|---|
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--ts <ms> | Timestamp of a single sample (unix ms) |
-j, --json | Output as JSON |
thinger bucket export
Export the data of a bucket to a file (or stdout) and download it
thinger bucket export [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | Data Bucket ID |
| Option | Description | Default |
|---|---|---|
-o, --output <file> | Write it to this file | |
--format <format> | csv, json or arff | csv |
--timestamps <format> | iso, seconds or milliseconds | iso |
--min-ts <ms> | From (unix ms; default: the first sample) | |
--max-ts <ms> | To (unix ms; default: the last sample) | |
--keep | Keep the export file on the server (listed by bucket export-file list) | |
-j, --json | Output as JSON |
thinger bucket import
Load records from a .csv already in a file storage (upload it with thinger storage file upload) into an existing bucket: body {source: "storage", storage, file}. Header row; ";" separated if the header has one, "," otherwise. The time column (ts, date or timestamp) takes unix MILLISECONDS (seconds are misread as ms) or ISO 8601, always taken as UTC. Other cells become numbers when they parse, text otherwise; empty and "null" are left out. Columns named like a bucket tag (config.tags) are stored as that tag: a device column in a bucket tagged device (product buckets are) makes the records readable per device. Writes straight to the backend (MongoDB or InfluxDB, not DynamoDB), with no rate limit and no bucket_write events; answers {"progress": N}, a percentage (100 when done; only the last line is shown). The way to load history in bulk: thinger bucket write is rate limited
thinger bucket import [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger bucket tag
Tags of a bucket and their values
thinger bucket tag [options] [command]| Command | Description |
|---|---|
thinger bucket tag list | List bucket tag records |
thinger bucket tag get | Show a bucket tag as JSON |
thinger bucket tag describe | Fields, examples and permissions of a bucket tag, from the server's API |
thinger bucket tag list
List bucket tag records
thinger bucket tag list [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger bucket tag get
Show a bucket tag as JSON
thinger bucket tag get [options] <bucket> <tag>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
tag | Yes | ID of the bucket tag |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger bucket tag describe
Fields, examples and permissions of a bucket tag, from the server's API
thinger bucket tag describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger bucket export-file
Exports of a bucket (files generated from its data)
thinger bucket export-file [options] [command]| Command | Description |
|---|---|
thinger bucket export-file list | List bucket export-file records |
thinger bucket export-file create | Create a bucket export-file from --from and --set |
thinger bucket export-file delete | Delete a bucket export-file |
thinger bucket export-file describe | Fields, examples and permissions of a bucket export-file, from the server's API |
thinger bucket export-file list
List bucket export-file records
thinger bucket export-file list [options] <bucket>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger bucket export-file create
Create a bucket export-file from --from and --set
thinger bucket export-file create [options] <bucket> [file]| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
file | No | ID of the bucket export |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger bucket export-file delete
Delete a bucket export-file
thinger bucket export-file delete [options] <bucket> <file>| Argument | Required | Description |
|---|---|---|
bucket | Yes | ID of the bucket |
file | Yes | ID of the bucket export |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger bucket export-file describe
Fields, examples and permissions of a bucket export-file, from the server's API
thinger bucket export-file describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger dashboard
Dashboards: apps on the dashboard SDK (create, develop and publish them) and their records
thinger dashboard [options] [command]| Command | Description |
|---|---|
thinger dashboard list | List dashboard records |
thinger dashboard get | Show a dashboard as JSON |
thinger dashboard create | Create a dashboard from --from and --set |
thinger dashboard update | Update fields of a dashboard (fields left out are kept) |
thinger dashboard delete | Delete a dashboard |
thinger dashboard clone | Copy a dashboard under a new id |
thinger dashboard describe | Fields, examples and permissions of a dashboard, from the server's API |
thinger dashboard init | Create a dashboard app (TypeScript, on @thinger-io/dashboard-sdk) from a template of the SDK |
thinger dashboard dev | Link that opens the app on its own dev server (ng serve, Vite…) against the server, with a temporary token |
thinger dashboard publish | Upload an app to a public storage and point dashboards at it |
thinger dashboard builds dashboards as web apps on the Dashboard SDK. init creates the project from a template of the SDK, dev prints a link that opens the app from its own dev server as a standalone page connected to your server, with a temporary token, and publish uploads the build to a public file storage and points the dashboards at it. See Dashboard apps for the workflow.
init writes a thinger.json manifest in the project folder. dev and publish read it from the current folder, or from the file given with --config; their options override it:
{
"dashboard": {
"dir": "dist",
"storage": "app_greenhouse_1a2b",
"prune": true,
"to": [{ "type": "device", "id": "YOUR_DEVICE" }],
"dev": { "url": "http://localhost:5173/" }
}
}| Field | Content |
|---|---|
dir | Build folder that publish uploads, relative to the manifest. It must be inside the project folder. |
storage | File storage the app is published to. publish creates it, public, if it does not exist. |
prune | true deletes files of the storage that are not in the upload. |
to | Destinations whose dashboard opens the app: { "type": "device", "id": "…" } with type device, product, asset_type, asset_group or project, or { "dashboard": "…" } for a dashboard. Each one can set its own entry and route. |
dev | Options of thinger dashboard dev: url of the dev server, context, route and hours the temporary token lasts. |
thinger dashboard init greenhouse --to device:YOUR_DEVICE --install
cd greenhouse
npm run build
thinger dashboard publishthinger dashboard list
List dashboard records
thinger dashboard list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger dashboard get
Show a dashboard as JSON
thinger dashboard get [options] <dashboard>| Argument | Required | Description |
|---|---|---|
dashboard | Yes | ID of the dashboard |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger dashboard create
Create a dashboard from --from and --set
thinger dashboard create [options] [dashboard]| Argument | Required | Description |
|---|---|---|
dashboard | No | ID of the dashboard |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger dashboard update
Update fields of a dashboard (fields left out are kept)
thinger dashboard update [options] <dashboard>| Argument | Required | Description |
|---|---|---|
dashboard | Yes | ID of the dashboard |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger dashboard delete
Delete a dashboard
thinger dashboard delete [options] <dashboard>| Argument | Required | Description |
|---|---|---|
dashboard | Yes | ID of the dashboard |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger dashboard clone
Copy a dashboard under a new id
thinger dashboard clone [options] <dashboard> <new-id>| Argument | Required | Description |
|---|---|---|
dashboard | Yes | ID of the dashboard |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger dashboard describe
Fields, examples and permissions of a dashboard, from the server's API
thinger dashboard describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger dashboard init
Create a dashboard app (TypeScript, on @thinger-io/dashboard-sdk) from a template of the SDK
thinger dashboard init [options] <dir>| Argument | Required | Description |
|---|---|---|
dir | Yes | New or empty folder for the app |
| Option | Description |
|---|---|
-t, --template <name> | Template of the SDK package: react, angular… (default react) |
--to <destination> | Where it publishes: device:<id>, product:<id>, dashboard:<id>… |
-s, --storage <id> | Storage it publishes to (default app_<folder>_<random>) |
--from <package> | SDK package to take the template from: a version or tag on npm, or a folder or .tgz |
--ci | Add a GitHub workflow that publishes it on every push to main |
--install | Run npm install |
-j, --json | Output as JSON |
thinger dashboard dev
Link that opens the app on its own dev server (ng serve, Vite…) against the server, with a temporary token
thinger dashboard dev [options] [url]| Argument | Required | Description |
|---|---|---|
url | No | Address of the app on its dev server (default: dev.url of the manifest) |
| Option | Description |
|---|---|
--to <destination> | Context of a destination: device:<id>, product:<id>, dashboard:<id>… |
--device <id> | Device in the SDK context |
--product <id> | Product in the SDK context |
--asset-type <id> | Asset type in the SDK context |
--asset-group <id> | Asset group in the SDK context |
--project <id> | Project the app runs in |
--route <route> | Initial route, e.g. /devices |
--hours <hours> | Hours the token lasts (default 8) |
--open | Open the link in the browser |
--allow-remote | Allow an app url that is not on this machine (the link carries a full-access token) |
--config <file> | Manifest (default thinger.json) |
-j, --json | Output as JSON |
thinger dashboard publish
Upload an app to a public storage and point dashboards at it
thinger dashboard publish [options] [dir]| Argument | Required | Description |
|---|---|---|
dir | No | Folder to upload (default: dir of the manifest) |
| Option | Description |
|---|---|
-s, --storage <id> | Storage of the app (created public if missing) |
--to <destination> | Dashboard to point (repeatable): dashboard:<id>, device:<id>, product:<id>, asset_type:<id>, asset_group:<id>, project:<id> |
--entry <page> | Page the destinations open (default index.html) |
--route <route> | Initial route of the destinations |
--name <name> | Name of a collection dashboard |
--prune | Delete files of the storage that are not in this upload |
--no-prune | Keep the storage's other files (overrides the manifest) |
--bump | Make consoles that have the app open reload it at once |
--preview [hours] | Also print standalone preview links (read-only, 1 h by default) |
--no-point | Upload without pointing the destinations (preview links only) |
--config <file> | Manifest (default thinger.json) |
-j, --json | Output as JSON |
thinger storage
File storages; their files are type storage_file
thinger storage [options] [command]| Command | Description |
|---|---|
thinger storage list | List storage records |
thinger storage get | Show a storage as JSON |
thinger storage create | Create a storage from --from and --set |
thinger storage update | Update fields of a storage (fields left out are kept) |
thinger storage delete | Delete a storage |
thinger storage clone | Copy a storage under a new id |
thinger storage describe | Fields, examples and permissions of a storage, from the server's API |
thinger storage file | Files of a file storage |
thinger storage list
List storage records
thinger storage list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger storage get
Show a storage as JSON
thinger storage get [options] <storage>| Argument | Required | Description |
|---|---|---|
storage | Yes | ID of the storage |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger storage create
Create a storage from --from and --set
thinger storage create [options] [storage]| Argument | Required | Description |
|---|---|---|
storage | No | ID of the storage |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger storage update
Update fields of a storage (fields left out are kept)
thinger storage update [options] <storage>| Argument | Required | Description |
|---|---|---|
storage | Yes | ID of the storage |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger storage delete
Delete a storage
thinger storage delete [options] <storage>| Argument | Required | Description |
|---|---|---|
storage | Yes | ID of the storage |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger storage clone
Copy a storage under a new id
thinger storage clone [options] <storage> <new-id>| Argument | Required | Description |
|---|---|---|
storage | Yes | ID of the storage |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger storage describe
Fields, examples and permissions of a storage, from the server's API
thinger storage describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger storage file
Files of a file storage
thinger storage file [options] [command]| Command | Description |
|---|---|
thinger storage file list | List the files of a storage, or of a folder in it |
thinger storage file delete | Delete a file of a storage |
thinger storage file upload | Upload a local file or folder (binary too), overwriting what is there; folders on the way are created |
thinger storage file download | Download a file: to -o, or printed (text) / piped (binary) |
thinger storage file list
List the files of a storage, or of a folder in it
thinger storage file list [options] <storage> [folder]| Argument | Required | Description |
|---|---|---|
storage | Yes | File storage ID |
folder | No | Folder of the storage to list (default: all the files) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger storage file delete
Delete a file of a storage
thinger storage file delete [options] <storage> <path>| Argument | Required | Description |
|---|---|---|
storage | Yes | File storage ID |
path | Yes | Path of the file in the storage |
| Option | Description |
|---|---|
-y, --yes | Do not ask for confirmation |
-j, --json | Output as JSON |
thinger storage file upload
Upload a local file or folder (binary too), overwriting what is there; folders on the way are created
thinger storage file upload [options] <storage> <local>| Argument | Required | Description |
|---|---|---|
storage | Yes | File storage ID |
local | Yes | Local file or folder |
| Option | Description |
|---|---|
--to <path> | Where in the storage: a file path, or the folder for a folder |
-j, --json | Output as JSON |
thinger storage file download
Download a file: to -o, or printed (text) / piped (binary)
thinger storage file download [options] <storage> <path>| Argument | Required | Description |
|---|---|---|
storage | Yes | File storage ID |
path | Yes | Path of the file in the storage |
| Option | Description |
|---|---|
-o, --output <file> | Write it to this file |
-j, --json | Output as JSON |
thinger plugin
Plugins installed on the account: containers that add features (integrations, apps); their API is reached with thinger plugin call
thinger plugin [options] [command]| Command | Description |
|---|---|
thinger plugin list | List plugin records |
thinger plugin get | Show a plugin as JSON |
thinger plugin describe | Fields, examples and permissions of a plugin, from the server's API |
thinger plugin call | Call the API a plugin serves, at its own path |
thinger plugin install | Install the plugin id (its name in the plugin catalog); the body holds its settings, query {version} picks one (default main). The container is created stopped: start it next |
thinger plugin upgrade | Upgrade the plugin to query {version} (default master); the body holds its settings. The container is recreated stopped (volumes kept): start it next |
thinger plugin uninstall | Uninstall the plugin: removes its container, files, volumes (its data) and properties |
thinger plugin start | Start the plugin container |
thinger plugin stop | Stop the plugin container |
thinger plugin restart | Restart the plugin container |
thinger plugin pause | Pause the plugin container |
thinger plugin unpause | Resume a paused plugin container |
thinger plugin kill | Kill the plugin container |
thinger plugin public | Make the plugin's web interface reachable without signing in |
thinger plugin private | Make the plugin's web interface require signing in again |
thinger plugin property | Properties of a plugin, usually its configuration |
thinger plugin list
List plugin records
thinger plugin list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger plugin get
Show a plugin as JSON
thinger plugin get [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger plugin describe
Fields, examples and permissions of a plugin, from the server's API
thinger plugin describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger plugin call
Call the API a plugin serves, at its own path
thinger plugin call [options] <plugin> [path]| Argument | Required | Description |
|---|---|---|
plugin | Yes | Plugin ID |
path | No | Path in the API of the plugin, e.g. /api/status |
| Option | Description |
|---|---|
-X, --method <method> | get, post, put, patch or delete (default: get, or post with a body) |
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-j, --json | Output as JSON |
thinger plugin install
Install the plugin id (its name in the plugin catalog); the body holds its settings, query {version} picks one (default main). The container is created stopped: start it next
thinger plugin install [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin upgrade
Upgrade the plugin to query {version} (default master); the body holds its settings. The container is recreated stopped (volumes kept): start it next
thinger plugin upgrade [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin uninstall
Uninstall the plugin: removes its container, files, volumes (its data) and properties
thinger plugin uninstall [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-y, --yes | Do not ask for confirmation |
thinger plugin start
Start the plugin container
thinger plugin start [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin stop
Stop the plugin container
thinger plugin stop [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin restart
Restart the plugin container
thinger plugin restart [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin pause
Pause the plugin container
thinger plugin pause [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin unpause
Resume a paused plugin container
thinger plugin unpause [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin kill
Kill the plugin container
thinger plugin kill [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin public
Make the plugin's web interface reachable without signing in
thinger plugin public [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin private
Make the plugin's web interface require signing in again
thinger plugin private [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin property
Properties of a plugin, usually its configuration
thinger plugin property [options] [command]| Command | Description |
|---|---|
thinger plugin property list | List plugin property records |
thinger plugin property get | Show a plugin property as JSON |
thinger plugin property create | Create a plugin property from --from and --set |
thinger plugin property update | Update fields of a plugin property (fields left out are kept) |
thinger plugin property delete | Delete a plugin property |
thinger plugin property clone | Copy a plugin property under a new id |
thinger plugin property set | Set the value of a plugin property (created when missing) |
thinger plugin property describe | Fields, examples and permissions of a plugin property, from the server's API |
thinger plugin property list
List plugin property records
thinger plugin property list [options] <plugin>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger plugin property get
Show a plugin property as JSON
thinger plugin property get [options] <plugin> <property>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
property | Yes | ID of the plugin property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger plugin property create
Create a plugin property from --from and --set
thinger plugin property create [options] <plugin> [property]| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
property | No | ID of the plugin property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin property update
Update fields of a plugin property (fields left out are kept)
thinger plugin property update [options] <plugin> <property>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
property | Yes | ID of the plugin property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--merge | Patch the value (JSON merge) instead of replacing it |
thinger plugin property delete
Delete a plugin property
thinger plugin property delete [options] <plugin> <property>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
property | Yes | ID of the plugin property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger plugin property clone
Copy a plugin property under a new id
thinger plugin property clone [options] <plugin> <property> <new-id>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
property | Yes | ID of the plugin property |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger plugin property set
Set the value of a plugin property (created when missing)
thinger plugin property set [options] <plugin> <property> <value>| Argument | Required | Description |
|---|---|---|
plugin | Yes | ID of the plugin |
property | Yes | ID of the plugin property |
value | Yes | Value, parsed as JSON (text when it is not JSON) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger plugin property describe
Fields, examples and permissions of a plugin property, from the server's API
thinger plugin property describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger endpoint
Endpoints: outgoing HTTP calls, emails, notifications (run one with its call action)
thinger endpoint [options] [command]| Command | Description |
|---|---|
thinger endpoint list | List endpoint records |
thinger endpoint get | Show an endpoint as JSON |
thinger endpoint create | Create an endpoint from --from and --set |
thinger endpoint update | Update fields of an endpoint (fields left out are kept) |
thinger endpoint delete | Delete an endpoint |
thinger endpoint clone | Copy an endpoint under a new id |
thinger endpoint describe | Fields, examples and permissions of an endpoint, from the server's API |
thinger endpoint call | Run the endpoint with the body as its payload (its templates see it as {{payload}}); returns what it answered |
thinger endpoint list
List endpoint records
thinger endpoint list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger endpoint get
Show an endpoint as JSON
thinger endpoint get [options] <endpoint>| Argument | Required | Description |
|---|---|---|
endpoint | Yes | ID of the endpoint |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger endpoint create
Create an endpoint from --from and --set
thinger endpoint create [options] [endpoint]| Argument | Required | Description |
|---|---|---|
endpoint | No | ID of the endpoint |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger endpoint update
Update fields of an endpoint (fields left out are kept)
thinger endpoint update [options] <endpoint>| Argument | Required | Description |
|---|---|---|
endpoint | Yes | ID of the endpoint |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger endpoint delete
Delete an endpoint
thinger endpoint delete [options] <endpoint>| Argument | Required | Description |
|---|---|---|
endpoint | Yes | ID of the endpoint |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger endpoint clone
Copy an endpoint under a new id
thinger endpoint clone [options] <endpoint> <new-id>| Argument | Required | Description |
|---|---|---|
endpoint | Yes | ID of the endpoint |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger endpoint describe
Fields, examples and permissions of an endpoint, from the server's API
thinger endpoint describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger endpoint call
Run the endpoint with the body as its payload (its templates see it as {{payload}}); returns what it answered
thinger endpoint call [options] <endpoint>| Argument | Required | Description |
|---|---|---|
endpoint | Yes | ID of the endpoint |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger asset
Assets: types and groups that organize devices
thinger asset [options] [command]| Command | Description |
|---|---|
thinger asset type | Asset types: a category of device (e.g. "boiler"), with its own properties |
thinger asset group | Asset groups: a set of devices (e.g. a site), with its own properties |
thinger asset type
Asset types: a category of device (e.g. "boiler"), with its own properties
thinger asset type [options] [command]| Command | Description |
|---|---|
thinger asset type list | List asset type records |
thinger asset type get | Show an asset type as JSON |
thinger asset type create | Create an asset type from --from and --set |
thinger asset type update | Update fields of an asset type (fields left out are kept) |
thinger asset type delete | Delete an asset type |
thinger asset type clone | Copy an asset type under a new id |
thinger asset type describe | Fields, examples and permissions of an asset type, from the server's API |
thinger asset type property | Properties of an asset type |
thinger asset type list
List asset type records
thinger asset type list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger asset type get
Show an asset type as JSON
thinger asset type get [options] <type>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger asset type create
Create an asset type from --from and --set
thinger asset type create [options] [type]| Argument | Required | Description |
|---|---|---|
type | No | ID of the asset type |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger asset type update
Update fields of an asset type (fields left out are kept)
thinger asset type update [options] <type>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger asset type delete
Delete an asset type
thinger asset type delete [options] <type>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger asset type clone
Copy an asset type under a new id
thinger asset type clone [options] <type> <new-id>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger asset type describe
Fields, examples and permissions of an asset type, from the server's API
thinger asset type describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger asset type property
Properties of an asset type
thinger asset type property [options] [command]| Command | Description |
|---|---|
thinger asset type property list | List asset type property records |
thinger asset type property get | Show an asset type property as JSON |
thinger asset type property create | Create an asset type property from --from and --set |
thinger asset type property update | Update fields of an asset type property (fields left out are kept) |
thinger asset type property delete | Delete an asset type property |
thinger asset type property clone | Copy an asset type property under a new id |
thinger asset type property set | Set the value of an asset type property (created when missing) |
thinger asset type property describe | Fields, examples and permissions of an asset type property, from the server's API |
thinger asset type property list
List asset type property records
thinger asset type property list [options] <type>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger asset type property get
Show an asset type property as JSON
thinger asset type property get [options] <type> <property>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
property | Yes | ID of the asset type property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger asset type property create
Create an asset type property from --from and --set
thinger asset type property create [options] <type> [property]| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
property | No | ID of the asset type property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger asset type property update
Update fields of an asset type property (fields left out are kept)
thinger asset type property update [options] <type> <property>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
property | Yes | ID of the asset type property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--merge | Patch the value (JSON merge) instead of replacing it |
thinger asset type property delete
Delete an asset type property
thinger asset type property delete [options] <type> <property>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
property | Yes | ID of the asset type property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger asset type property clone
Copy an asset type property under a new id
thinger asset type property clone [options] <type> <property> <new-id>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
property | Yes | ID of the asset type property |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger asset type property set
Set the value of an asset type property (created when missing)
thinger asset type property set [options] <type> <property> <value>| Argument | Required | Description |
|---|---|---|
type | Yes | ID of the asset type |
property | Yes | ID of the asset type property |
value | Yes | Value, parsed as JSON (text when it is not JSON) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger asset type property describe
Fields, examples and permissions of an asset type property, from the server's API
thinger asset type property describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger asset group
Asset groups: a set of devices (e.g. a site), with its own properties
thinger asset group [options] [command]| Command | Description |
|---|---|
thinger asset group list | List asset group records |
thinger asset group get | Show an asset group as JSON |
thinger asset group create | Create an asset group from --from and --set |
thinger asset group update | Update fields of an asset group (fields left out are kept) |
thinger asset group delete | Delete an asset group |
thinger asset group clone | Copy an asset group under a new id |
thinger asset group describe | Fields, examples and permissions of an asset group, from the server's API |
thinger asset group property | Properties of an asset group |
thinger asset group list
List asset group records
thinger asset group list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger asset group get
Show an asset group as JSON
thinger asset group get [options] <group>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger asset group create
Create an asset group from --from and --set
thinger asset group create [options] [group]| Argument | Required | Description |
|---|---|---|
group | No | ID of the asset group |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger asset group update
Update fields of an asset group (fields left out are kept)
thinger asset group update [options] <group>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger asset group delete
Delete an asset group
thinger asset group delete [options] <group>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger asset group clone
Copy an asset group under a new id
thinger asset group clone [options] <group> <new-id>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger asset group describe
Fields, examples and permissions of an asset group, from the server's API
thinger asset group describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger asset group property
Properties of an asset group
thinger asset group property [options] [command]| Command | Description |
|---|---|
thinger asset group property list | List asset group property records |
thinger asset group property get | Show an asset group property as JSON |
thinger asset group property create | Create an asset group property from --from and --set |
thinger asset group property update | Update fields of an asset group property (fields left out are kept) |
thinger asset group property delete | Delete an asset group property |
thinger asset group property clone | Copy an asset group property under a new id |
thinger asset group property set | Set the value of an asset group property (created when missing) |
thinger asset group property describe | Fields, examples and permissions of an asset group property, from the server's API |
thinger asset group property list
List asset group property records
thinger asset group property list [options] <group>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger asset group property get
Show an asset group property as JSON
thinger asset group property get [options] <group> <property>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
property | Yes | ID of the asset group property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger asset group property create
Create an asset group property from --from and --set
thinger asset group property create [options] <group> [property]| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
property | No | ID of the asset group property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger asset group property update
Update fields of an asset group property (fields left out are kept)
thinger asset group property update [options] <group> <property>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
property | Yes | ID of the asset group property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--merge | Patch the value (JSON merge) instead of replacing it |
thinger asset group property delete
Delete an asset group property
thinger asset group property delete [options] <group> <property>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
property | Yes | ID of the asset group property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger asset group property clone
Copy an asset group property under a new id
thinger asset group property clone [options] <group> <property> <new-id>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
property | Yes | ID of the asset group property |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger asset group property set
Set the value of an asset group property (created when missing)
thinger asset group property set [options] <group> <property> <value>| Argument | Required | Description |
|---|---|---|
group | Yes | ID of the asset group |
property | Yes | ID of the asset group property |
value | Yes | Value, parsed as JSON (text when it is not JSON) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger asset group property describe
Fields, examples and permissions of an asset group property, from the server's API
thinger asset group property describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger project
Projects: group resources of any type to share them or show them together
thinger project [options] [command]| Command | Description |
|---|---|
thinger project list | List project records |
thinger project get | Show a project as JSON |
thinger project create | Create a project from --from and --set |
thinger project update | Update fields of a project (fields left out are kept) |
thinger project delete | Delete a project |
thinger project clone | Copy a project under a new id |
thinger project describe | Fields, examples and permissions of a project, from the server's API |
thinger project property | Properties of a project |
thinger project member | Members a project is shared with, and their roles |
thinger project role | Roles defined inside a project |
thinger project list
List project records
thinger project list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger project get
Show a project as JSON
thinger project get [options] <project>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger project create
Create a project from --from and --set
thinger project create [options] [project]| Argument | Required | Description |
|---|---|---|
project | No | ID of the project |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project update
Update fields of a project (fields left out are kept)
thinger project update [options] <project>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project delete
Delete a project
thinger project delete [options] <project>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger project clone
Copy a project under a new id
thinger project clone [options] <project> <new-id>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project describe
Fields, examples and permissions of a project, from the server's API
thinger project describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger project property
Properties of a project
thinger project property [options] [command]| Command | Description |
|---|---|
thinger project property list | List project property records |
thinger project property get | Show a project property as JSON |
thinger project property create | Create a project property from --from and --set |
thinger project property update | Update fields of a project property (fields left out are kept) |
thinger project property delete | Delete a project property |
thinger project property clone | Copy a project property under a new id |
thinger project property set | Set the value of a project property (created when missing) |
thinger project property describe | Fields, examples and permissions of a project property, from the server's API |
thinger project property list
List project property records
thinger project property list [options] <project>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger project property get
Show a project property as JSON
thinger project property get [options] <project> <property>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
property | Yes | ID of the project property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger project property create
Create a project property from --from and --set
thinger project property create [options] <project> [property]| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
property | No | ID of the project property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project property update
Update fields of a project property (fields left out are kept)
thinger project property update [options] <project> <property>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
property | Yes | ID of the project property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--merge | Patch the value (JSON merge) instead of replacing it |
thinger project property delete
Delete a project property
thinger project property delete [options] <project> <property>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
property | Yes | ID of the project property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger project property clone
Copy a project property under a new id
thinger project property clone [options] <project> <property> <new-id>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
property | Yes | ID of the project property |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project property set
Set the value of a project property (created when missing)
thinger project property set [options] <project> <property> <value>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
property | Yes | ID of the project property |
value | Yes | Value, parsed as JSON (text when it is not JSON) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger project property describe
Fields, examples and permissions of a project property, from the server's API
thinger project property describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger project member
Members a project is shared with, and their roles
thinger project member [options] [command]| Command | Description |
|---|---|
thinger project member list | List project member records |
thinger project member get | Show a project member as JSON |
thinger project member create | Create a project member from --from and --set |
thinger project member update | Update fields of a project member (fields left out are kept) |
thinger project member delete | Delete a project member |
thinger project member describe | Fields, examples and permissions of a project member, from the server's API |
thinger project member list
List project member records
thinger project member list [options] <project>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger project member get
Show a project member as JSON
thinger project member get [options] <project> <member>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
member | Yes | ID of the project member |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger project member create
Create a project member from --from and --set
thinger project member create [options] <project> [member]| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
member | No | ID of the project member |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project member update
Update fields of a project member (fields left out are kept)
thinger project member update [options] <project> <member>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
member | Yes | ID of the project member |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project member delete
Delete a project member
thinger project member delete [options] <project> <member>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
member | Yes | ID of the project member |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger project member describe
Fields, examples and permissions of a project member, from the server's API
thinger project member describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger project role
Roles defined inside a project
thinger project role [options] [command]| Command | Description |
|---|---|
thinger project role list | List project role records |
thinger project role get | Show a project role as JSON |
thinger project role create | Create a project role from --from and --set |
thinger project role update | Update fields of a project role (fields left out are kept) |
thinger project role delete | Delete a project role |
thinger project role clone | Copy a project role under a new id |
thinger project role describe | Fields, examples and permissions of a project role, from the server's API |
thinger project role list
List project role records
thinger project role list [options] <project>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger project role get
Show a project role as JSON
thinger project role get [options] <project> <role>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
role | Yes | ID of the project role |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger project role create
Create a project role from --from and --set
thinger project role create [options] <project> [role]| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
role | No | ID of the project role |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project role update
Update fields of a project role (fields left out are kept)
thinger project role update [options] <project> <role>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
role | Yes | ID of the project role |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project role delete
Delete a project role
thinger project role delete [options] <project> <role>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
role | Yes | ID of the project role |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger project role clone
Copy a project role under a new id
thinger project role clone [options] <project> <role> <new-id>| Argument | Required | Description |
|---|---|---|
project | Yes | ID of the project |
role | Yes | ID of the project role |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger project role describe
Fields, examples and permissions of a project role, from the server's API
thinger project role describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger token
Access tokens of the account, with their permission tree
thinger token [options] [command]| Command | Description |
|---|---|
thinger token list | List token records |
thinger token get | Show a token as JSON |
thinger token create | Create a token from --from and --set |
thinger token update | Update fields of a token (fields left out are kept) |
thinger token delete | Delete a token |
thinger token clone | Copy a token under a new id |
thinger token describe | Fields, examples and permissions of a token, from the server's API |
thinger token list
List token records
thinger token list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger token get
Show a token as JSON
thinger token get [options] <token>| Argument | Required | Description |
|---|---|---|
token | Yes | ID of the token |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger token create
Create a token from --from and --set
thinger token create [options] [token]| Argument | Required | Description |
|---|---|---|
token | No | ID of the token |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger token update
Update fields of a token (fields left out are kept)
thinger token update [options] <token>| Argument | Required | Description |
|---|---|---|
token | Yes | ID of the token |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger token delete
Delete a token
thinger token delete [options] <token>| Argument | Required | Description |
|---|---|---|
token | Yes | ID of the token |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger token clone
Copy a token under a new id
thinger token clone [options] <token> <new-id>| Argument | Required | Description |
|---|---|---|
token | Yes | ID of the token |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger token describe
Fields, examples and permissions of a token, from the server's API
thinger token describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger alarm
Alarms: the rules that watch devices and buckets, and the instances they raise
thinger alarm [options] [command]| Command | Description |
|---|---|
thinger alarm rule | Alarm rules: conditions on device or bucket data that raise alarm instances |
thinger alarm instance | Alarm instances raised by the rules; update them to acknowledge, shelve or clear |
thinger alarm rule
Alarm rules: conditions on device or bucket data that raise alarm instances
thinger alarm rule [options] [command]| Command | Description |
|---|---|
thinger alarm rule list | List alarm rule records |
thinger alarm rule get | Show an alarm rule as JSON |
thinger alarm rule create | Create an alarm rule from --from and --set |
thinger alarm rule update | Update fields of an alarm rule (fields left out are kept) |
thinger alarm rule delete | Delete an alarm rule |
thinger alarm rule clone | Copy an alarm rule under a new id |
thinger alarm rule describe | Fields, examples and permissions of an alarm rule, from the server's API |
thinger alarm rule test | Evaluate a whole rule without raising alarms or notifying: the body is the rule as it would be saved ({name, enabled, config}), and the rule id may not exist yet. Without the body, it tests the saved rule |
thinger alarm rule test-source | Read one data source as the rule would (the rule id need not exist; the source comes in the body): the body is {name, source: "bucket" | "device_property" | "device_status", <source>: {…}}, e.g. {name: "loc", source: "device_property", device_property: {device: "d1", property: "location"}}. A bucket source without aggregation reads the window of check_interval (as in config.check_interval; default the saved rule's, or 1 minute) |
thinger alarm rule test-notification | Send the rule notification for real, through its endpoints, with the body as the event data: people get it |
thinger alarm rule list
List alarm rule records
thinger alarm rule list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger alarm rule get
Show an alarm rule as JSON
thinger alarm rule get [options] <rule>| Argument | Required | Description |
|---|---|---|
rule | Yes | ID of the alarm rule |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger alarm rule create
Create an alarm rule from --from and --set
thinger alarm rule create [options] [rule]| Argument | Required | Description |
|---|---|---|
rule | No | ID of the alarm rule |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger alarm rule update
Update fields of an alarm rule (fields left out are kept)
thinger alarm rule update [options] <rule>| Argument | Required | Description |
|---|---|---|
rule | Yes | ID of the alarm rule |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger alarm rule delete
Delete an alarm rule
thinger alarm rule delete [options] <rule>| Argument | Required | Description |
|---|---|---|
rule | Yes | ID of the alarm rule |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger alarm rule clone
Copy an alarm rule under a new id
thinger alarm rule clone [options] <rule> <new-id>| Argument | Required | Description |
|---|---|---|
rule | Yes | ID of the alarm rule |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger alarm rule describe
Fields, examples and permissions of an alarm rule, from the server's API
thinger alarm rule describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger alarm rule test
Evaluate a whole rule without raising alarms or notifying: the body is the rule as it would be saved ({name, enabled, config}), and the rule id may not exist yet. Without the body, it tests the saved rule
thinger alarm rule test [options] <rule>| Argument | Required | Description |
|---|---|---|
rule | Yes | ID of the alarm rule |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger alarm rule test-source
Read one data source as the rule would (the rule id need not exist; the source comes in the body): the body is {name, source: "bucket" | "device_property" | "device_status", <source>: {…}}, e.g. {name: "loc", source: "device_property", device_property: {device: "d1", property: "location"}}. A bucket source without aggregation reads the window of check_interval (as in config.check_interval; default the saved rule's, or 1 minute)
thinger alarm rule test-source [options] <rule>| Argument | Required | Description |
|---|---|---|
rule | Yes | ID of the alarm rule |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger alarm rule test-notification
Send the rule notification for real, through its endpoints, with the body as the event data: people get it
thinger alarm rule test-notification [options] <rule>| Argument | Required | Description |
|---|---|---|
rule | Yes | ID of the alarm rule |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger alarm instance
Alarm instances raised by the rules; update them to acknowledge, shelve or clear
thinger alarm instance [options] [command]| Command | Description |
|---|---|
thinger alarm instance list | List alarm instance records |
thinger alarm instance get | Show an alarm instance as JSON |
thinger alarm instance update | Update fields of an alarm instance (fields left out are kept) |
thinger alarm instance delete | Delete an alarm instance |
thinger alarm instance describe | Fields, examples and permissions of an alarm instance, from the server's API |
thinger alarm instance stats | How many instances there are in each state: the health of the account at a glance, without listing them |
thinger alarm instance list
List alarm instance records
thinger alarm instance list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger alarm instance get
Show an alarm instance as JSON
thinger alarm instance get [options] <instance>| Argument | Required | Description |
|---|---|---|
instance | Yes | ID of the alarm instance |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger alarm instance update
Update fields of an alarm instance (fields left out are kept)
thinger alarm instance update [options] <instance>| Argument | Required | Description |
|---|---|---|
instance | Yes | ID of the alarm instance |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger alarm instance delete
Delete an alarm instance
thinger alarm instance delete [options] <instance>| Argument | Required | Description |
|---|---|---|
instance | Yes | ID of the alarm instance |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger alarm instance describe
Fields, examples and permissions of an alarm instance, from the server's API
thinger alarm instance describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger alarm instance stats
How many instances there are in each state: the health of the account at a glance, without listing them
thinger alarm instance stats [options]| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
thinger claim
Device claims: codes that let end users take ownership of a device
thinger claim [options] [command]| Command | Description |
|---|---|
thinger claim list | List claim records |
thinger claim get | Show a claim as JSON |
thinger claim create | Create a claim from --from and --set |
thinger claim update | Update fields of a claim (fields left out are kept) |
thinger claim delete | Delete a claim |
thinger claim clone | Copy a claim under a new id |
thinger claim describe | Fields, examples and permissions of a claim, from the server's API |
thinger claim list
List claim records
thinger claim list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger claim get
Show a claim as JSON
thinger claim get [options] <claim>| Argument | Required | Description |
|---|---|---|
claim | Yes | ID of the claim |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger claim create
Create a claim from --from and --set
thinger claim create [options] [claim]| Argument | Required | Description |
|---|---|---|
claim | No | ID of the claim |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger claim update
Update fields of a claim (fields left out are kept)
thinger claim update [options] <claim>| Argument | Required | Description |
|---|---|---|
claim | Yes | ID of the claim |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger claim delete
Delete a claim
thinger claim delete [options] <claim>| Argument | Required | Description |
|---|---|---|
claim | Yes | ID of the claim |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger claim clone
Copy a claim under a new id
thinger claim clone [options] <claim> <new-id>| Argument | Required | Description |
|---|---|---|
claim | Yes | ID of the claim |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger claim describe
Fields, examples and permissions of a claim, from the server's API
thinger claim describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger property
Account properties: JSON values stored on the account
thinger property [options] [command]| Command | Description |
|---|---|
thinger property list | List property records |
thinger property get | Show a property as JSON |
thinger property create | Create a property from --from and --set |
thinger property update | Update fields of a property (fields left out are kept) |
thinger property delete | Delete a property |
thinger property clone | Copy a property under a new id |
thinger property set | Set the value of a property (created when missing) |
thinger property describe | Fields, examples and permissions of a property, from the server's API |
thinger property list
List property records
thinger property list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger property get
Show a property as JSON
thinger property get [options] <property>| Argument | Required | Description |
|---|---|---|
property | Yes | ID of the property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger property create
Create a property from --from and --set
thinger property create [options] [property]| Argument | Required | Description |
|---|---|---|
property | No | ID of the property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger property update
Update fields of a property (fields left out are kept)
thinger property update [options] <property>| Argument | Required | Description |
|---|---|---|
property | Yes | ID of the property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--merge | Patch the value (JSON merge) instead of replacing it |
thinger property delete
Delete a property
thinger property delete [options] <property>| Argument | Required | Description |
|---|---|---|
property | Yes | ID of the property |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger property clone
Copy a property under a new id
thinger property clone [options] <property> <new-id>| Argument | Required | Description |
|---|---|---|
property | Yes | ID of the property |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger property set
Set the value of a property (created when missing)
thinger property set [options] <property> <value>| Argument | Required | Description |
|---|---|---|
property | Yes | ID of the property |
value | Yes | Value, parsed as JSON (text when it is not JSON) |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger property describe
Fields, examples and permissions of a property, from the server's API
thinger property describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger role
Roles: named permission sets for project members
thinger role [options] [command]| Command | Description |
|---|---|
thinger role list | List role records |
thinger role get | Show a role as JSON |
thinger role create | Create a role from --from and --set |
thinger role update | Update fields of a role (fields left out are kept) |
thinger role delete | Delete a role |
thinger role clone | Copy a role under a new id |
thinger role describe | Fields, examples and permissions of a role, from the server's API |
thinger role list
List role records
thinger role list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger role get
Show a role as JSON
thinger role get [options] <role>| Argument | Required | Description |
|---|---|---|
role | Yes | ID of the role |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger role create
Create a role from --from and --set
thinger role create [options] [role]| Argument | Required | Description |
|---|---|---|
role | No | ID of the role |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger role update
Update fields of a role (fields left out are kept)
thinger role update [options] <role>| Argument | Required | Description |
|---|---|---|
role | Yes | ID of the role |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger role delete
Delete a role
thinger role delete [options] <role>| Argument | Required | Description |
|---|---|---|
role | Yes | ID of the role |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger role clone
Copy a role under a new id
thinger role clone [options] <role> <new-id>| Argument | Required | Description |
|---|---|---|
role | Yes | ID of the role |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger role describe
Fields, examples and permissions of a role, from the server's API
thinger role describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger sync
Syncs: shared semaphores with a number of slots that devices or scripts take (locks) to coordinate
thinger sync [options] [command]| Command | Description |
|---|---|
thinger sync list | List sync records |
thinger sync get | Show a sync as JSON |
thinger sync create | Create a sync from --from and --set |
thinger sync update | Update fields of a sync (fields left out are kept) |
thinger sync delete | Delete a sync |
thinger sync clone | Copy a sync under a new id |
thinger sync describe | Fields, examples and permissions of a sync, from the server's API |
thinger sync lock | Locks of a sync: slots currently taken |
thinger sync list
List sync records
thinger sync list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger sync get
Show a sync as JSON
thinger sync get [options] <sync>| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger sync create
Create a sync from --from and --set
thinger sync create [options] [sync]| Argument | Required | Description |
|---|---|---|
sync | No | ID of the sync |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger sync update
Update fields of a sync (fields left out are kept)
thinger sync update [options] <sync>| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--projects <list> | Projects it belongs to, comma-separated "<owner>@<project>" |
thinger sync delete
Delete a sync
thinger sync delete [options] <sync>| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger sync clone
Copy a sync under a new id
thinger sync clone [options] <sync> <new-id>| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
new-id | Yes | ID of the copy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger sync describe
Fields, examples and permissions of a sync, from the server's API
thinger sync describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger sync lock
Locks of a sync: slots currently taken
thinger sync lock [options] [command]| Command | Description |
|---|---|
thinger sync lock list | List sync lock records |
thinger sync lock get | Show a sync lock as JSON |
thinger sync lock create | Create a sync lock from --from and --set |
thinger sync lock update | Update fields of a sync lock (fields left out are kept) |
thinger sync lock delete | Delete a sync lock |
thinger sync lock describe | Fields, examples and permissions of a sync lock, from the server's API |
thinger sync lock list
List sync lock records
thinger sync lock list [options] <sync>| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger sync lock get
Show a sync lock as JSON
thinger sync lock get [options] <sync> <lock>| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
lock | Yes | ID of the sync lock |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger sync lock create
Create a sync lock from --from and --set
thinger sync lock create [options] <sync> [lock]| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
lock | No | ID of the sync lock |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger sync lock update
Update fields of a sync lock (fields left out are kept)
thinger sync lock update [options] <sync> <lock>| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
lock | Yes | ID of the sync lock |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger sync lock delete
Delete a sync lock
thinger sync lock delete [options] <sync> <lock>| Argument | Required | Description |
|---|---|---|
sync | Yes | ID of the sync |
lock | Yes | ID of the sync lock |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger sync lock describe
Fields, examples and permissions of a sync lock, from the server's API
thinger sync lock describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger admin
Server administration (admin accounts): users, hosts, domains, brands…
thinger admin [options] [command]| Command | Description |
|---|---|
thinger admin user | User accounts of the server |
thinger admin host | Hosts of the server cluster |
thinger admin domain | Custom domains the server answers on |
thinger admin brand | Brands: the look (and email) of the console on a domain |
thinger admin oauth-client | OAuth clients: applications allowed to sign users in against this server |
thinger admin identity-provider | Identity providers: external sign-in (OpenID Connect, OAuth) for the console |
thinger admin proxy | Proxies: services the server exposes through its own address |
thinger admin user
User accounts of the server
thinger admin user [options] [command]| Command | Description |
|---|---|
thinger admin user list | List user records |
thinger admin user get | Show an user as JSON |
thinger admin user create | Create an user from --from and --set |
thinger admin user update | Update fields of an user (fields left out are kept) |
thinger admin user delete | Delete an user |
thinger admin user describe | Fields, examples and permissions of an user, from the server's API |
thinger admin user list
List user records
thinger admin user list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger admin user get
Show an user as JSON
thinger admin user get [options] <user>| Argument | Required | Description |
|---|---|---|
user | Yes | ID of the user |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger admin user create
Create an user from --from and --set
thinger admin user create [options] [user]| Argument | Required | Description |
|---|---|---|
user | No | ID of the user |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin user update
Update fields of an user (fields left out are kept)
thinger admin user update [options] <user>| Argument | Required | Description |
|---|---|---|
user | Yes | ID of the user |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin user delete
Delete an user
thinger admin user delete [options] <user>| Argument | Required | Description |
|---|---|---|
user | Yes | ID of the user |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger admin user describe
Fields, examples and permissions of an user, from the server's API
thinger admin user describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger admin host
Hosts of the server cluster
thinger admin host [options] [command]| Command | Description |
|---|---|
thinger admin host list | List host records |
thinger admin host get | Show a host as JSON |
thinger admin host create | Create a host from --from and --set |
thinger admin host update | Update fields of a host (fields left out are kept) |
thinger admin host delete | Delete a host |
thinger admin host describe | Fields, examples and permissions of a host, from the server's API |
thinger admin host logs | The last lines of the host log, as text. query: {lines: 200, timestamps: true, since: …}. Reads the server container named in deployment.container_name (default "thinger"): not found means it has another name |
thinger admin host restart | Restart the host: its devices and users lose the connection meanwhile |
thinger admin host get-settings | Read the host settings |
thinger admin host update-settings | Patch the host settings with the body (JSON merge: keys left out stay, null removes one); read them first |
thinger admin host list
List host records
thinger admin host list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger admin host get
Show a host as JSON
thinger admin host get [options] <host>| Argument | Required | Description |
|---|---|---|
host | Yes | ID of the host |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger admin host create
Create a host from --from and --set
thinger admin host create [options] [host]| Argument | Required | Description |
|---|---|---|
host | No | ID of the host |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin host update
Update fields of a host (fields left out are kept)
thinger admin host update [options] <host>| Argument | Required | Description |
|---|---|---|
host | Yes | ID of the host |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin host delete
Delete a host
thinger admin host delete [options] <host>| Argument | Required | Description |
|---|---|---|
host | Yes | ID of the host |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger admin host describe
Fields, examples and permissions of a host, from the server's API
thinger admin host describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger admin host logs
The last lines of the host log, as text. query: {lines: 200, timestamps: true, since: …}. Reads the server container named in deployment.container_name (default "thinger"): not found means it has another name
thinger admin host logs [options] <host>| Argument | Required | Description |
|---|---|---|
host | Yes | ID of the host |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
thinger admin host restart
Restart the host: its devices and users lose the connection meanwhile
thinger admin host restart [options] <host>| Argument | Required | Description |
|---|---|---|
host | Yes | ID of the host |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-y, --yes | Do not ask for confirmation |
thinger admin host get-settings
Read the host settings
thinger admin host get-settings [options] <host>| Argument | Required | Description |
|---|---|---|
host | Yes | ID of the host |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
thinger admin host update-settings
Patch the host settings with the body (JSON merge: keys left out stay, null removes one); read them first
thinger admin host update-settings [options] <host>| Argument | Required | Description |
|---|---|---|
host | Yes | ID of the host |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin domain
Custom domains the server answers on
thinger admin domain [options] [command]| Command | Description |
|---|---|
thinger admin domain list | List domain records |
thinger admin domain get | Show a domain as JSON |
thinger admin domain create | Create a domain from --from and --set |
thinger admin domain update | Update fields of a domain (fields left out are kept) |
thinger admin domain delete | Delete a domain |
thinger admin domain describe | Fields, examples and permissions of a domain, from the server's API |
thinger admin domain verify | Check that the domain resolves to this server (after the user configures its DNS) |
thinger admin domain list
List domain records
thinger admin domain list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger admin domain get
Show a domain as JSON
thinger admin domain get [options] <domain>| Argument | Required | Description |
|---|---|---|
domain | Yes | ID of the domain |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger admin domain create
Create a domain from --from and --set
thinger admin domain create [options] [domain]| Argument | Required | Description |
|---|---|---|
domain | No | ID of the domain |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin domain update
Update fields of a domain (fields left out are kept)
thinger admin domain update [options] <domain>| Argument | Required | Description |
|---|---|---|
domain | Yes | ID of the domain |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin domain delete
Delete a domain
thinger admin domain delete [options] <domain>| Argument | Required | Description |
|---|---|---|
domain | Yes | ID of the domain |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger admin domain describe
Fields, examples and permissions of a domain, from the server's API
thinger admin domain describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger admin domain verify
Check that the domain resolves to this server (after the user configures its DNS)
thinger admin domain verify [options] <domain>| Argument | Required | Description |
|---|---|---|
domain | Yes | ID of the domain |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin brand
Brands: the look (and email) of the console on a domain
thinger admin brand [options] [command]| Command | Description |
|---|---|
thinger admin brand list | List brand records |
thinger admin brand get | Show a brand as JSON |
thinger admin brand create | Create a brand from --from and --set |
thinger admin brand update | Update fields of a brand (fields left out are kept) |
thinger admin brand delete | Delete a brand |
thinger admin brand describe | Fields, examples and permissions of a brand, from the server's API |
thinger admin brand test-email | Send a test email with the brand's email settings |
thinger admin brand list
List brand records
thinger admin brand list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger admin brand get
Show a brand as JSON
thinger admin brand get [options] <brand>| Argument | Required | Description |
|---|---|---|
brand | Yes | ID of the brand |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger admin brand create
Create a brand from --from and --set
thinger admin brand create [options] [brand]| Argument | Required | Description |
|---|---|---|
brand | No | ID of the brand |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin brand update
Update fields of a brand (fields left out are kept)
thinger admin brand update [options] <brand>| Argument | Required | Description |
|---|---|---|
brand | Yes | ID of the brand |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
--merge | Patch the value (JSON merge) instead of replacing it |
thinger admin brand delete
Delete a brand
thinger admin brand delete [options] <brand>| Argument | Required | Description |
|---|---|---|
brand | Yes | ID of the brand |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger admin brand describe
Fields, examples and permissions of a brand, from the server's API
thinger admin brand describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger admin brand test-email
Send a test email with the brand's email settings
thinger admin brand test-email [options] <brand>| Argument | Required | Description |
|---|---|---|
brand | Yes | ID of the brand |
| Option | Description |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) |
-f, --field <path> | Print only this field of the answer (dot path) |
-o, --output <file> | Write the answer to a file |
-j, --json | Output as JSON |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin oauth-client
OAuth clients: applications allowed to sign users in against this server
thinger admin oauth-client [options] [command]| Command | Description |
|---|---|
thinger admin oauth-client list | List oauth-client records |
thinger admin oauth-client get | Show an oauth-client as JSON |
thinger admin oauth-client create | Create an oauth-client from --from and --set |
thinger admin oauth-client update | Update fields of an oauth-client (fields left out are kept) |
thinger admin oauth-client delete | Delete an oauth-client |
thinger admin oauth-client describe | Fields, examples and permissions of an oauth-client, from the server's API |
thinger admin oauth-client list
List oauth-client records
thinger admin oauth-client list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger admin oauth-client get
Show an oauth-client as JSON
thinger admin oauth-client get [options] <oauth-client>| Argument | Required | Description |
|---|---|---|
oauth-client | Yes | ID of the oauth client |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger admin oauth-client create
Create an oauth-client from --from and --set
thinger admin oauth-client create [options] [oauth-client]| Argument | Required | Description |
|---|---|---|
oauth-client | No | ID of the oauth client |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin oauth-client update
Update fields of an oauth-client (fields left out are kept)
thinger admin oauth-client update [options] <oauth-client>| Argument | Required | Description |
|---|---|---|
oauth-client | Yes | ID of the oauth client |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin oauth-client delete
Delete an oauth-client
thinger admin oauth-client delete [options] <oauth-client>| Argument | Required | Description |
|---|---|---|
oauth-client | Yes | ID of the oauth client |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger admin oauth-client describe
Fields, examples and permissions of an oauth-client, from the server's API
thinger admin oauth-client describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger admin identity-provider
Identity providers: external sign-in (OpenID Connect, OAuth) for the console
thinger admin identity-provider [options] [command]| Command | Description |
|---|---|
thinger admin identity-provider list | List identity-provider records |
thinger admin identity-provider get | Show an identity-provider as JSON |
thinger admin identity-provider create | Create an identity-provider from --from and --set |
thinger admin identity-provider update | Update fields of an identity-provider (fields left out are kept) |
thinger admin identity-provider delete | Delete an identity-provider |
thinger admin identity-provider describe | Fields, examples and permissions of an identity-provider, from the server's API |
thinger admin identity-provider list
List identity-provider records
thinger admin identity-provider list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger admin identity-provider get
Show an identity-provider as JSON
thinger admin identity-provider get [options] <identity-provider>| Argument | Required | Description |
|---|---|---|
identity-provider | Yes | ID of the identity provider |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger admin identity-provider create
Create an identity-provider from --from and --set
thinger admin identity-provider create [options] [identity-provider]| Argument | Required | Description |
|---|---|---|
identity-provider | No | ID of the identity provider |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin identity-provider update
Update fields of an identity-provider (fields left out are kept)
thinger admin identity-provider update [options] <identity-provider>| Argument | Required | Description |
|---|---|---|
identity-provider | Yes | ID of the identity provider |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin identity-provider delete
Delete an identity-provider
thinger admin identity-provider delete [options] <identity-provider>| Argument | Required | Description |
|---|---|---|
identity-provider | Yes | ID of the identity provider |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger admin identity-provider describe
Fields, examples and permissions of an identity-provider, from the server's API
thinger admin identity-provider describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger admin proxy
Proxies: services the server exposes through its own address
thinger admin proxy [options] [command]| Command | Description |
|---|---|
thinger admin proxy list | List proxy records |
thinger admin proxy get | Show a proxy as JSON |
thinger admin proxy create | Create a proxy from --from and --set |
thinger admin proxy update | Update fields of a proxy (fields left out are kept) |
thinger admin proxy delete | Delete a proxy |
thinger admin proxy describe | Fields, examples and permissions of a proxy, from the server's API |
thinger admin proxy list
List proxy records
thinger admin proxy list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
--search <text> | Text to look for in ids and names |
--filter <key=value> | Filter (repeatable): product, type, asset_type, asset_group, project, labels, or a field of the records |
--count <n> | Page size (default: all) |
--index <n> | Offset of the first record |
thinger admin proxy get
Show a proxy as JSON
thinger admin proxy get [options] <proxy>| Argument | Required | Description |
|---|---|---|
proxy | Yes | ID of the proxy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-f, --field <path> | Print only this field (dot path, e.g. config.source) |
-o, --output <file> | Write the JSON to a file |
thinger admin proxy create
Create a proxy from --from and --set
thinger admin proxy create [options] [proxy]| Argument | Required | Description |
|---|---|---|
proxy | No | ID of the proxy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin proxy update
Update fields of a proxy (fields left out are kept)
thinger admin proxy update [options] <proxy>| Argument | Required | Description |
|---|---|---|
proxy | Yes | ID of the proxy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-n, --name <name> | Name (over --from and --set) |
-d, --description <text> | Description (over --from and --set) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
thinger admin proxy delete
Delete a proxy
thinger admin proxy delete [options] <proxy>| Argument | Required | Description |
|---|---|---|
proxy | Yes | ID of the proxy |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
-y, --yes | Do not ask for confirmation |
thinger admin proxy describe
Fields, examples and permissions of a proxy, from the server's API
thinger admin proxy describe [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger login
Sign in: re-authenticate the current profile, or create the first one. Use profile add for more servers.
thinger login [options]| Option | Description |
|---|---|
--server <server> | Server host (or URL for http / custom ports) |
--username <username> | Account username |
--token <token> | Existing API token (non-interactive login with --server and --username) |
--oauth | Sign in through the browser (OAuth device flow) |
--client-id <id> | OAuth client id registered on the server |
thinger logout
Forget the current profile (or --all) and revoke the API token the CLI created
thinger logout [options]| Option | Description |
|---|---|
--all | Forget every profile |
--keep-token | Do not revoke the API token on the server |
thinger profile
Manage configuration profiles
thinger profile [options] [command]| Command | Description |
|---|---|
thinger profile list | List configured profiles |
thinger profile current | Print the active profile |
thinger profile use | Set the default profile |
thinger profile add | Add a profile for another server (interactive, or with --server/--username/--token) |
thinger profile delete | Remove a profile |
thinger profile list
List configured profiles
thinger profile list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger profile current
Print the active profile
thinger profile current [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger profile use
Set the default profile
thinger profile use [options] <name>| Argument | Required | Description |
|---|---|---|
name | Yes | Profile name |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger profile add
Add a profile for another server (interactive, or with --server/--username/--token)
thinger profile add [options] [name]| Argument | Required | Description |
|---|---|---|
name | No | Profile name (asked when missing) |
| Option | Description |
|---|---|
--no-activate | Do not set the new profile as default |
--server <server> | Server host (or URL for http / custom ports) |
--username <username> | Account username |
--token <token> | Existing API token (non-interactive with --server and --username) |
--oauth | Sign in through the browser (OAuth device flow) |
--client-id <id> | OAuth client id registered on the server |
-j, --json | Output as JSON |
thinger profile delete
Remove a profile
thinger profile delete [options] <name>| Argument | Required | Description |
|---|---|---|
name | Yes | Profile name |
| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger api
Send a request to the server API (anything the commands do not cover)
thinger api [options] <path>| Argument | Required | Description |
|---|---|---|
path | Yes | API path, e.g. /v1/users/{user}/devices ({user}: your account) |
| Option | Description |
|---|---|
-X, --method <method> | GET, POST, PUT, PATCH or DELETE (default: GET, or POST with a body) |
--from <file> | JSON body from a file, or - for stdin |
-s, --set <key=value> | Body field (repeatable; values parsed as JSON when they are; dots nest: data.source=resource) |
-q, --query <key=value> | Query parameter (repeatable) |
-o, --output <file> | Write the answer to a file (downloads, binary answers) |
-j, --json | Output as JSON ({ ok, data }) |
thinger doc
Guides for agents and app developers: the platform, product code, the dashboard SDK, this CLI
thinger doc [options] [command]| Command | Description |
|---|---|
thinger doc list | List the guides: the platform, product code, the dashboard SDK, this CLI |
thinger doc get | Print a guide (Markdown), whole |
thinger doc list
List the guides: the platform, product code, the dashboard SDK, this CLI
thinger doc list [options]| Option | Description |
|---|---|
-j, --json | Output as JSON |
thinger doc get
Print a guide (Markdown), whole
thinger doc get [options] <doc>| Argument | Required | Description |
|---|---|---|
doc | Yes | ID of the guide (doc list gives them) |
| Option | Description |
|---|---|
-o, --output <file> | Write it to a file |
-j, --json | Output as JSON |
thinger mcp
Start the MCP server (stdio) for AI tool integration
thinger mcp [options]| Option | Description |
|---|---|
--read-only | Serve only the tools that read: describe, list, get and the read-only actions (or set THINGER_MCP_READ_ONLY=1) |
thinger mcp starts an MCP server over standard input and output with the session of the active profile, so an AI client can work with your account. Sign in first with thinger login. To register it in Claude Code for all your projects:
claude mcp add --scope user thinger -- thinger mcpthinger mcp --read-only (or THINGER_MCP_READ_ONLY=1) serves only the tools and actions that read, to let an agent explore an account without changing anything.
Other MCP clients take the same command: thinger with the argument mcp. How to set up each client (Claude Desktop, VS Code, Cursor and others) is in Connect an AI agent, and the tools the server offers are listed in MCP tools.
Without installing the CLI
npx -y @thinger-io/cli mcp runs the server without installing the CLI, for example in Claude Code or a CI job. Desktop apps are more reliable with the installed thinger command: see Connect an AI agent.