Skip to content

Reference

CLI

Every command and option of the thinger CLI, plus how to install it, sign in, use profiles, script it with JSON output and run its MCP server.

Reference129 min read

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.

  • Install: Install, on this page (@thinger-io/cli-core comes 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:

bash
npm install -g @thinger-io/cli

Check the installed version:

bash
thinger --version

You 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.

MethodHowWhat 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.
Tokenthinger 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 passwordthinger 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:

bash
thinger profile add staging --server YOUR_SERVER --username YOUR_USER --token YOUR_TOKEN
thinger profile list
thinger profile use staging
thinger device list --profile production

The CLI picks the profile in this order:

  1. The --profile <name> option of the command.
  2. The THINGER_PROFILE environment variable.
  3. THINGER_TOKEN and THINGER_SERVER, when both are set (see Environment variables).
  4. The default profile, set with thinger profile use. The first profile you create becomes the default.

Environment variables ​

VariableEffect
THINGER_TOKENAccess 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_SERVERServer for THINGER_TOKEN: a host, or a URL for HTTP or a custom port. Setting THINGER_TOKEN without it is an error.
THINGER_PROFILEProfile to use when the command has no --profile.
THINGER_INSECURESet 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:

bash
THINGER_SERVER=YOUR_SERVER THINGER_TOKEN=YOUR_TOKEN thinger device list --json

JSON 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:

json
{
  "ok": true,
  "data": { "device": "YOUR_DEVICE", "product": null }
}

On failure, the envelope carries the error message and a code:

json
{
  "ok": false,
  "error": {
    "message": "Unauthorized. Your token may have expired. Please reconfigure.",
    "code": "unauthorized"
  }
}
codeMeaning
unauthorizedThe token is missing, expired or not valid for the server (HTTP 401), or it is not allowed to do this (HTTP 403, Forbidden).
not_foundThe device, product, bucket or other resource does not exist.
already_existsA resource with that ID already exists.
input_errorAn argument or option is not valid.
not_configuredThere is no profile: run thinger login.
needs_confirmA destructive command needs --yes in JSON mode or when there is no terminal to confirm it.
server_errorThe server answered with an error.
network_errorThe server could not be reached.
timeoutThe server did not answer in time.
errorAny 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:

text
thinger [options] [command]
OptionDescription
-V, --versionoutput the version number
-u, --user <username>API user override (admin impersonation)
--profile <name>Configuration profile to use (defaults to the saved default)
-h, --helpDisplay help for the command.

Add --help to any command or group to print its usage, for example thinger dashboard publish --help.

Commands ​

CommandDescription
thinger deviceDevices: records, properties, resources, data and their children
thinger productProducts: records, properties, profile and their export
thinger bucketData buckets: records, time series, exports and tags
thinger dashboardDashboards: apps on the dashboard SDK (create, develop and publish them) and their records
thinger storageFile storages; their files are type storage_file
thinger pluginPlugins installed on the account: containers that add features (integrations, apps); their API is reached with thinger plugin call
thinger endpointEndpoints: outgoing HTTP calls, emails, notifications (run one with its call action)
thinger assetAssets: types and groups that organize devices
thinger projectProjects: group resources of any type to share them or show them together
thinger tokenAccess tokens of the account, with their permission tree
thinger alarmAlarms: the rules that watch devices and buckets, and the instances they raise
thinger claimDevice claims: codes that let end users take ownership of a device
thinger propertyAccount properties: JSON values stored on the account
thinger roleRoles: named permission sets for project members
thinger syncSyncs: shared semaphores with a number of slots that devices or scripts take (locks) to coordinate
thinger adminServer administration (admin accounts): users, hosts, domains, brands…
thinger loginSign in: re-authenticate the current profile, or create the first one. Use profile add for more servers.
thinger logoutForget the current profile (or --all) and revoke the API token the CLI created
thinger profileManage configuration profiles
thinger apiSend a request to the server API (anything the commands do not cover)
thinger docGuides for agents and app developers: the platform, product code, the dashboard SDK, this CLI
thinger mcpStart the MCP server (stdio) for AI tool integration

thinger device ​

Devices: records, properties, resources, data and their children

text
thinger device [options] [command]
CommandDescription
thinger device listList devices: online state, id, name, type and product
thinger device getShow a device as JSON
thinger device createRegister a device; Generic/MQTT ones get random credentials unless given
thinger device updateUpdate fields of a device (fields left out are kept)
thinger device deleteDelete a device record from the platform (irreversible)
thinger device cloneCopy a device under a new id
thinger device describeFields, examples and permissions of a device, from the server's API
thinger device sendSend data as an HTTP device would: the server runs the device's callback
thinger device overviewUsage of all the devices over the last 30 days, per day
thinger device set-productAssign a device to a product ("" to unassign)
thinger device statsUsage over the last 30 days, per day: traffic and calls (empty when the server does not record usage)
thinger device resourceResources of a connected device: its firmware's API and its product's
thinger device propertyProperties of a device: its structured state (configuration, calibration…)
thinger device tokenTokens scoped to one device and some of its resources
thinger device bucketBuckets that hold data of a device (read-only listing)
thinger device serviceServices a device exposes (web, VNC…)
thinger device callbackHTTP 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

text
thinger device list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger device get [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-j, --jsonOutput 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

text
thinger device create [options] [device]
ArgumentRequiredDescription
deviceNoDevice ID
OptionDescription
-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, --jsonOutput as JSON

thinger device update ​

Update fields of a device (fields left out are kept)

text
thinger device update [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-j, --jsonOutput 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)

text
thinger device delete [options] <device>
ArgumentRequiredDescription
deviceYesDevice ID
OptionDescription
-y, --yesSkip the interactive confirmation prompt
-j, --jsonOutput as JSON

thinger device clone ​

Copy a device under a new id

text
thinger device clone [options] <device> <new-id>
ArgumentRequiredDescription
deviceYesID of the device
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger device describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger device send ​

Send data as an HTTP device would: the server runs the device's callback

text
thinger device send [options] <device>
ArgumentRequiredDescription
deviceYesDevice ID
OptionDescription
-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, --jsonOutput as JSON

thinger device overview ​

Usage of all the devices over the last 30 days, per day

text
thinger device overview [options]
OptionDescription
--locationsAlso the last known position of each connected device
-j, --jsonOutput as JSON

thinger device set-product ​

Assign a device to a product ("" to unassign)

text
thinger device set-product [options] <device> <product>
ArgumentRequiredDescription
deviceYesDevice ID
productYesProduct ID ("" removes the device from its product)
OptionDescription
-j, --jsonOutput as JSON

thinger device stats ​

Usage over the last 30 days, per day: traffic and calls (empty when the server does not record usage)

text
thinger device stats [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-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, --jsonOutput as JSON

thinger device resource ​

Resources of a connected device: its firmware's API and its product's

text
thinger device resource [options] [command]
CommandDescription
thinger device resource listList the resources a connected device exposes, with their inputs and outputs
thinger device resource callCall 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

text
thinger device resource list [options] <device>
ArgumentRequiredDescription
deviceYesDevice ID
OptionDescription
-j, --jsonOutput 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

text
thinger device resource call [options] <device> <resource>
ArgumentRequiredDescription
deviceYesDevice ID
resourceYesResource of the device to call
OptionDescription
-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, --jsonOutput as JSON

thinger device property ​

Properties of a device: its structured state (configuration, calibration…)

text
thinger device property [options] [command]
CommandDescription
thinger device property listList device property records
thinger device property getShow a device property as JSON
thinger device property createCreate a device property from --from and --set
thinger device property updateUpdate fields of a device property (fields left out are kept)
thinger device property deleteDelete a device property
thinger device property cloneCopy a device property under a new id
thinger device property setSet the value of a device property (created when missing)
thinger device property describeFields, examples and permissions of a device property, from the server's API

thinger device property list ​

List device property records

text
thinger device property list [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-j, --jsonOutput 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

text
thinger device property get [options] <device> <property>
ArgumentRequiredDescription
deviceYesID of the device
propertyYesID of the device property
OptionDescription
-j, --jsonOutput 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

text
thinger device property create [options] <device> [property]
ArgumentRequiredDescription
deviceYesID of the device
propertyNoID of the device property
OptionDescription
-j, --jsonOutput 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)

text
thinger device property update [options] <device> <property>
ArgumentRequiredDescription
deviceYesID of the device
propertyYesID of the device property
OptionDescription
-j, --jsonOutput 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)
--mergePatch the value (JSON merge) instead of replacing it

thinger device property delete ​

Delete a device property

text
thinger device property delete [options] <device> <property>
ArgumentRequiredDescription
deviceYesID of the device
propertyYesID of the device property
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger device property clone ​

Copy a device property under a new id

text
thinger device property clone [options] <device> <property> <new-id>
ArgumentRequiredDescription
deviceYesID of the device
propertyYesID of the device property
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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)

text
thinger device property set [options] <device> <property> <value>
ArgumentRequiredDescription
deviceYesID of the device
propertyYesID of the device property
valueYesValue, parsed as JSON (text when it is not JSON)
OptionDescription
-j, --jsonOutput as JSON

thinger device property describe ​

Fields, examples and permissions of a device property, from the server's API

text
thinger device property describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger device token ​

Tokens scoped to one device and some of its resources

text
thinger device token [options] [command]
CommandDescription
thinger device token listList device token records
thinger device token createCreate a device token from --from and --set
thinger device token deleteDelete a device token
thinger device token describeFields, examples and permissions of a device token, from the server's API

thinger device token list ​

List device token records

text
thinger device token list [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-j, --jsonOutput 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

text
thinger device token create [options] <device> [token]
ArgumentRequiredDescription
deviceYesID of the device
tokenNoID of the device token
OptionDescription
-j, --jsonOutput 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

text
thinger device token delete [options] <device> <token>
ArgumentRequiredDescription
deviceYesID of the device
tokenYesID of the device token
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger device token describe ​

Fields, examples and permissions of a device token, from the server's API

text
thinger device token describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger device bucket ​

Buckets that hold data of a device (read-only listing)

text
thinger device bucket [options] [command]
CommandDescription
thinger device bucket listList device bucket records
thinger device bucket describeFields, examples and permissions of a device bucket, from the server's API
thinger device bucket tagTags of a device bucket

thinger device bucket list ​

List device bucket records

text
thinger device bucket list [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-j, --jsonOutput 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

text
thinger device bucket describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger device bucket tag ​

Tags of a device bucket

text
thinger device bucket tag [options] [command]
CommandDescription
thinger device bucket tag listList device bucket tag records
thinger device bucket tag getShow a device bucket tag as JSON
thinger device bucket tag describeFields, examples and permissions of a device bucket tag, from the server's API

thinger device bucket tag list ​

List device bucket tag records

text
thinger device bucket tag list [options] <device> <bucket>
ArgumentRequiredDescription
deviceYesID of the device
bucketYesID of the device bucket
OptionDescription
-j, --jsonOutput 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

text
thinger device bucket tag get [options] <device> <bucket> <tag>
ArgumentRequiredDescription
deviceYesID of the device
bucketYesID of the device bucket
tagYesID of the device bucket tag
OptionDescription
-j, --jsonOutput 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

text
thinger device bucket tag describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger device service ​

Services a device exposes (web, VNC…)

text
thinger device service [options] [command]
CommandDescription
thinger device service listList device service records
thinger device service getShow a device service as JSON
thinger device service describeFields, examples and permissions of a device service, from the server's API

thinger device service list ​

List device service records

text
thinger device service list [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-j, --jsonOutput 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

text
thinger device service get [options] <device> <service>
ArgumentRequiredDescription
deviceYesID of the device
serviceYesID of the device service
OptionDescription
-j, --jsonOutput 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

text
thinger device service describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger device callback ​

HTTP callback settings of a device: what the server does with the data it receives

text
thinger device callback [options] [command]
CommandDescription
thinger device callback getShow a device callback as JSON
thinger device callback updateUpdate fields of a device callback (fields left out are kept)
thinger device callback describeFields, examples and permissions of a device callback, from the server's API

thinger device callback get ​

Show a device callback as JSON

text
thinger device callback get [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-j, --jsonOutput 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)

text
thinger device callback update [options] <device>
ArgumentRequiredDescription
deviceYesID of the device
OptionDescription
-j, --jsonOutput 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

text
thinger device callback describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger product ​

Products: records, properties, profile and their export

text
thinger product [options] [command]
CommandDescription
thinger product listList the products of the account, with their API resources
thinger product getShow a product as JSON
thinger product createCreate a product, bare or from a JSON document (config + profile); the CLI template fills in the rest
thinger product updateUpdate fields of a product (fields left out are kept)
thinger product deleteDelete a product (its devices stay, unassigned)
thinger product cloneCopy a product under a new id
thinger product describeFields, examples and permissions of a product, from the server's API
thinger product exportThe product with what it depends on, as one JSON document, to back it up or recreate it
thinger product applyCreate or update a product from the JSON product export writes (profile and properties included)
thinger product profileProfile of a product: the API resources, buckets, properties, autoprovisioning, flows and code its devices get
thinger product propertyProperties of a product
thinger product serviceServices a product exposes on its devices

thinger product list ​

List the products of the account, with their API resources

text
thinger product list [options]
OptionDescriptionDefault
-j, --jsonOutput 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

text
thinger product get [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product create [options] [product]
ArgumentRequiredDescription
productNoProduct ID
OptionDescription
-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, --jsonOutput as JSON

thinger product update ​

Update fields of a product (fields left out are kept)

text
thinger product update [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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)

text
thinger product delete [options] <product>
ArgumentRequiredDescription
productYesProduct ID
OptionDescription
-y, --yesSkip the interactive confirmation prompt
-j, --jsonOutput as JSON

thinger product clone ​

Copy a product under a new id

text
thinger product clone [options] <product> <new-id>
ArgumentRequiredDescription
productYesID of the product
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger product describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger product export ​

The product with what it depends on, as one JSON document, to back it up or recreate it

text
thinger product export [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-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, --jsonOutput as JSON

thinger product apply ​

Create or update a product from the JSON product export writes (profile and properties included)

text
thinger product apply [options]
OptionDescription
--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, --jsonOutput as JSON

thinger product profile ​

Profile of a product: the API resources, buckets, properties, autoprovisioning, flows and code its devices get

text
thinger product profile [options] [command]
CommandDescription
thinger product profile apiAPI resources a product adds to its devices (calls to device resources, endpoints, scripts)
thinger product profile bucketBuckets a product keeps for each of its devices
thinger product profile propertyProperties a product creates on each of its devices
thinger product profile autoprovisionAutoprovisioning rules: which connecting devices join the product
thinger product profile flowData flows of a product: periodic reads of device resources
thinger product profile codeScript 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)

text
thinger product profile api [options] [command]
CommandDescription
thinger product profile api listList product profile api records
thinger product profile api getShow a product profile api as JSON
thinger product profile api createCreate a product profile api from --from and --set
thinger product profile api updateUpdate fields of a product profile api (fields left out are kept)
thinger product profile api deleteDelete a product profile api
thinger product profile api describeFields, examples and permissions of a product profile api, from the server's API
thinger product profile api callCall a product API resource for the whole product (needs its device_id_resolver)
thinger product profile api replace-allReplace 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

text
thinger product profile api list [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product profile api get [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile api
OptionDescription
-j, --jsonOutput 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

text
thinger product profile api create [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile api
OptionDescription
-j, --jsonOutput 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)

text
thinger product profile api update [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile api
OptionDescription
-j, --jsonOutput 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

text
thinger product profile api delete [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile api
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger product profile api describe ​

Fields, examples and permissions of a product profile api, from the server's API

text
thinger product profile api describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger product profile api call ​

Call a product API resource for the whole product (needs its device_id_resolver)

text
thinger product profile api call [options] <product> <resource>
ArgumentRequiredDescription
productYesProduct ID
resourceYesAPI resource of the product profile
OptionDescription
-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, --jsonOutput 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

text
thinger product profile api replace-all [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-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, --jsonOutput 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, --yesDo not ask for confirmation

thinger product profile bucket ​

Buckets a product keeps for each of its devices

text
thinger product profile bucket [options] [command]
CommandDescription
thinger product profile bucket listList product profile bucket records
thinger product profile bucket getShow a product profile bucket as JSON
thinger product profile bucket createCreate a product profile bucket from --from and --set
thinger product profile bucket updateUpdate fields of a product profile bucket (fields left out are kept)
thinger product profile bucket deleteDelete a product profile bucket
thinger product profile bucket describeFields, examples and permissions of a product profile bucket, from the server's API
thinger product profile bucket replace-allReplace 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

text
thinger product profile bucket list [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product profile bucket get [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile bucket
OptionDescription
-j, --jsonOutput 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

text
thinger product profile bucket create [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile bucket
OptionDescription
-j, --jsonOutput 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)

text
thinger product profile bucket update [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile bucket
OptionDescription
-j, --jsonOutput 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

text
thinger product profile bucket delete [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile bucket
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger product profile bucket describe ​

Fields, examples and permissions of a product profile bucket, from the server's API

text
thinger product profile bucket describe [options]
OptionDescription
-j, --jsonOutput 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

text
thinger product profile bucket replace-all [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-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, --jsonOutput 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, --yesDo not ask for confirmation

thinger product profile property ​

Properties a product creates on each of its devices

text
thinger product profile property [options] [command]
CommandDescription
thinger product profile property listList product profile property records
thinger product profile property getShow a product profile property as JSON
thinger product profile property createCreate a product profile property from --from and --set
thinger product profile property updateUpdate fields of a product profile property (fields left out are kept)
thinger product profile property deleteDelete a product profile property
thinger product profile property describeFields, examples and permissions of a product profile property, from the server's API
thinger product profile property replace-allReplace 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

text
thinger product profile property list [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product profile property get [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile property
OptionDescription
-j, --jsonOutput 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

text
thinger product profile property create [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile property
OptionDescription
-j, --jsonOutput 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)

text
thinger product profile property update [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile property
OptionDescription
-j, --jsonOutput 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

text
thinger product profile property delete [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile property
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger product profile property describe ​

Fields, examples and permissions of a product profile property, from the server's API

text
thinger product profile property describe [options]
OptionDescription
-j, --jsonOutput 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

text
thinger product profile property replace-all [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-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, --jsonOutput 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, --yesDo not ask for confirmation

thinger product profile autoprovision ​

Autoprovisioning rules: which connecting devices join the product

text
thinger product profile autoprovision [options] [command]
CommandDescription
thinger product profile autoprovision listList product profile autoprovision records
thinger product profile autoprovision getShow a product profile autoprovision as JSON
thinger product profile autoprovision createCreate a product profile autoprovision from --from and --set
thinger product profile autoprovision updateUpdate fields of a product profile autoprovision (fields left out are kept)
thinger product profile autoprovision deleteDelete a product profile autoprovision
thinger product profile autoprovision describeFields, examples and permissions of a product profile autoprovision, from the server's API
thinger product profile autoprovision replace-allReplace 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

text
thinger product profile autoprovision list [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product profile autoprovision get [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile autoprovision
OptionDescription
-j, --jsonOutput 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

text
thinger product profile autoprovision create [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile autoprovision
OptionDescription
-j, --jsonOutput 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)

text
thinger product profile autoprovision update [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile autoprovision
OptionDescription
-j, --jsonOutput 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

text
thinger product profile autoprovision delete [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile autoprovision
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger product profile autoprovision describe ​

Fields, examples and permissions of a product profile autoprovision, from the server's API

text
thinger product profile autoprovision describe [options]
OptionDescription
-j, --jsonOutput 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

text
thinger product profile autoprovision replace-all [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-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, --jsonOutput 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, --yesDo not ask for confirmation

thinger product profile flow ​

Data flows of a product: periodic reads of device resources

text
thinger product profile flow [options] [command]
CommandDescription
thinger product profile flow listList product profile flow records
thinger product profile flow getShow a product profile flow as JSON
thinger product profile flow createCreate a product profile flow from --from and --set
thinger product profile flow updateUpdate fields of a product profile flow (fields left out are kept)
thinger product profile flow deleteDelete a product profile flow
thinger product profile flow describeFields, examples and permissions of a product profile flow, from the server's API
thinger product profile flow replace-allReplace 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

text
thinger product profile flow list [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product profile flow get [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile flow
OptionDescription
-j, --jsonOutput 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

text
thinger product profile flow create [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile flow
OptionDescription
-j, --jsonOutput 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)

text
thinger product profile flow update [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile flow
OptionDescription
-j, --jsonOutput 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

text
thinger product profile flow delete [options] <product> <resource>
ArgumentRequiredDescription
productYesID of the product
resourceYesID of the product profile flow
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger product profile flow describe ​

Fields, examples and permissions of a product profile flow, from the server's API

text
thinger product profile flow describe [options]
OptionDescription
-j, --jsonOutput 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

text
thinger product profile flow replace-all [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-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, --jsonOutput 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, --yesDo not ask for confirmation

thinger product profile code ​

Script code of a product (JavaScript run by the server for its devices)

text
thinger product profile code [options] [command]
CommandDescription
thinger product profile code getShow a product profile code as JSON
thinger product profile code updateUpdate fields of a product profile code (fields left out are kept)
thinger product profile code describeFields, 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

text
thinger product profile code get [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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)

text
thinger product profile code update [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product profile code describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger product property ​

Properties of a product

text
thinger product property [options] [command]
CommandDescription
thinger product property listList product property records
thinger product property getShow a product property as JSON
thinger product property createCreate a product property from --from and --set
thinger product property updateUpdate fields of a product property (fields left out are kept)
thinger product property deleteDelete a product property
thinger product property cloneCopy a product property under a new id
thinger product property setSet the value of a product property (created when missing)
thinger product property describeFields, examples and permissions of a product property, from the server's API

thinger product property list ​

List product property records

text
thinger product property list [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product property get [options] <product> <property>
ArgumentRequiredDescription
productYesID of the product
propertyYesID of the product property
OptionDescription
-j, --jsonOutput 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

text
thinger product property create [options] <product> [property]
ArgumentRequiredDescription
productYesID of the product
propertyNoID of the product property
OptionDescription
-j, --jsonOutput 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)

text
thinger product property update [options] <product> <property>
ArgumentRequiredDescription
productYesID of the product
propertyYesID of the product property
OptionDescription
-j, --jsonOutput 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)
--mergePatch the value (JSON merge) instead of replacing it

thinger product property delete ​

Delete a product property

text
thinger product property delete [options] <product> <property>
ArgumentRequiredDescription
productYesID of the product
propertyYesID of the product property
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger product property clone ​

Copy a product property under a new id

text
thinger product property clone [options] <product> <property> <new-id>
ArgumentRequiredDescription
productYesID of the product
propertyYesID of the product property
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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)

text
thinger product property set [options] <product> <property> <value>
ArgumentRequiredDescription
productYesID of the product
propertyYesID of the product property
valueYesValue, parsed as JSON (text when it is not JSON)
OptionDescription
-j, --jsonOutput as JSON

thinger product property describe ​

Fields, examples and permissions of a product property, from the server's API

text
thinger product property describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger product service ​

Services a product exposes on its devices

text
thinger product service [options] [command]
CommandDescription
thinger product service listList product service records
thinger product service getShow a product service as JSON
thinger product service createCreate a product service from --from and --set
thinger product service updateUpdate fields of a product service (fields left out are kept)
thinger product service deleteDelete a product service
thinger product service describeFields, examples and permissions of a product service, from the server's API

thinger product service list ​

List product service records

text
thinger product service list [options] <product>
ArgumentRequiredDescription
productYesID of the product
OptionDescription
-j, --jsonOutput 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

text
thinger product service get [options] <product> <service>
ArgumentRequiredDescription
productYesID of the product
serviceYesID of the product service
OptionDescription
-j, --jsonOutput 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

text
thinger product service create [options] <product> <service>
ArgumentRequiredDescription
productYesID of the product
serviceYesID of the product service
OptionDescription
-j, --jsonOutput 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)

text
thinger product service update [options] <product> <service>
ArgumentRequiredDescription
productYesID of the product
serviceYesID of the product service
OptionDescription
-j, --jsonOutput 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

text
thinger product service delete [options] <product> <service>
ArgumentRequiredDescription
productYesID of the product
serviceYesID of the product service
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger product service describe ​

Fields, examples and permissions of a product service, from the server's API

text
thinger product service describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger bucket ​

Data buckets: records, time series, exports and tags

text
thinger bucket [options] [command]
CommandDescription
thinger bucket listList the data buckets of the account
thinger bucket getShow a bucket as JSON
thinger bucket createCreate a bucket from --from and --set
thinger bucket updateUpdate fields of a bucket (fields left out are kept)
thinger bucket deleteDelete a bucket
thinger bucket cloneCopy a bucket under a new id
thinger bucket describeFields, examples and permissions of a bucket, from the server's API
thinger bucket readRead samples from a bucket (latest first by default)
thinger bucket writeWrite samples: one JSON object, an array of them with their ts (unix ms), or NDJSON
thinger bucket exportExport the data of a bucket to a file (or stdout) and download it
thinger bucket importLoad 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 tagTags of a bucket and their values
thinger bucket export-fileExports of a bucket (files generated from its data)

thinger bucket list ​

List the data buckets of the account

text
thinger bucket list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger bucket get [options] <bucket>
ArgumentRequiredDescription
bucketYesID of the bucket
OptionDescription
-j, --jsonOutput 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

text
thinger bucket create [options] [bucket]
ArgumentRequiredDescription
bucketNoID of the bucket
OptionDescription
-j, --jsonOutput 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)

text
thinger bucket update [options] <bucket>
ArgumentRequiredDescription
bucketYesID of the bucket
OptionDescription
-j, --jsonOutput 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

text
thinger bucket delete [options] <bucket>
ArgumentRequiredDescription
bucketYesID of the bucket
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger bucket clone ​

Copy a bucket under a new id

text
thinger bucket clone [options] <bucket> <new-id>
ArgumentRequiredDescription
bucketYesID of the bucket
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger bucket describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger bucket read ​

Read samples from a bucket (latest first by default)

text
thinger bucket read [options] <bucket>
ArgumentRequiredDescription
bucketYesData Bucket ID
OptionDescriptionDefault
-d, --device <device>Series a product bucket keeps for this device
-n, --items <n>Number of samples10
-m, --minutes <n>Only the last N minutes
--sort <order>asc or descdesc
--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, --jsonOutput as JSON

thinger bucket write ​

Write samples: one JSON object, an array of them with their ts (unix ms), or NDJSON

text
thinger bucket write [options] <bucket>
ArgumentRequiredDescription
bucketYesData Bucket ID
OptionDescription
--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, --jsonOutput as JSON

thinger bucket export ​

Export the data of a bucket to a file (or stdout) and download it

text
thinger bucket export [options] <bucket>
ArgumentRequiredDescription
bucketYesData Bucket ID
OptionDescriptionDefault
-o, --output <file>Write it to this file
--format <format>csv, json or arffcsv
--timestamps <format>iso, seconds or millisecondsiso
--min-ts <ms>From (unix ms; default: the first sample)
--max-ts <ms>To (unix ms; default: the last sample)
--keepKeep the export file on the server (listed by bucket export-file list)
-j, --jsonOutput 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

text
thinger bucket import [options] <bucket>
ArgumentRequiredDescription
bucketYesID of the bucket
OptionDescription
-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, --jsonOutput 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

text
thinger bucket tag [options] [command]
CommandDescription
thinger bucket tag listList bucket tag records
thinger bucket tag getShow a bucket tag as JSON
thinger bucket tag describeFields, examples and permissions of a bucket tag, from the server's API

thinger bucket tag list ​

List bucket tag records

text
thinger bucket tag list [options] <bucket>
ArgumentRequiredDescription
bucketYesID of the bucket
OptionDescription
-j, --jsonOutput 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

text
thinger bucket tag get [options] <bucket> <tag>
ArgumentRequiredDescription
bucketYesID of the bucket
tagYesID of the bucket tag
OptionDescription
-j, --jsonOutput 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

text
thinger bucket tag describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger bucket export-file ​

Exports of a bucket (files generated from its data)

text
thinger bucket export-file [options] [command]
CommandDescription
thinger bucket export-file listList bucket export-file records
thinger bucket export-file createCreate a bucket export-file from --from and --set
thinger bucket export-file deleteDelete a bucket export-file
thinger bucket export-file describeFields, examples and permissions of a bucket export-file, from the server's API

thinger bucket export-file list ​

List bucket export-file records

text
thinger bucket export-file list [options] <bucket>
ArgumentRequiredDescription
bucketYesID of the bucket
OptionDescription
-j, --jsonOutput 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

text
thinger bucket export-file create [options] <bucket> [file]
ArgumentRequiredDescription
bucketYesID of the bucket
fileNoID of the bucket export
OptionDescription
-j, --jsonOutput 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

text
thinger bucket export-file delete [options] <bucket> <file>
ArgumentRequiredDescription
bucketYesID of the bucket
fileYesID of the bucket export
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger bucket export-file describe ​

Fields, examples and permissions of a bucket export-file, from the server's API

text
thinger bucket export-file describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger dashboard ​

Dashboards: apps on the dashboard SDK (create, develop and publish them) and their records

text
thinger dashboard [options] [command]
CommandDescription
thinger dashboard listList dashboard records
thinger dashboard getShow a dashboard as JSON
thinger dashboard createCreate a dashboard from --from and --set
thinger dashboard updateUpdate fields of a dashboard (fields left out are kept)
thinger dashboard deleteDelete a dashboard
thinger dashboard cloneCopy a dashboard under a new id
thinger dashboard describeFields, examples and permissions of a dashboard, from the server's API
thinger dashboard initCreate a dashboard app (TypeScript, on @thinger-io/dashboard-sdk) from a template of the SDK
thinger dashboard devLink that opens the app on its own dev server (ng serve, Vite…) against the server, with a temporary token
thinger dashboard publishUpload 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:

thinger.json
json
{
  "dashboard": {
    "dir": "dist",
    "storage": "app_greenhouse_1a2b",
    "prune": true,
    "to": [{ "type": "device", "id": "YOUR_DEVICE" }],
    "dev": { "url": "http://localhost:5173/" }
  }
}
FieldContent
dirBuild folder that publish uploads, relative to the manifest. It must be inside the project folder.
storageFile storage the app is published to. publish creates it, public, if it does not exist.
prunetrue deletes files of the storage that are not in the upload.
toDestinations 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.
devOptions of thinger dashboard dev: url of the dev server, context, route and hours the temporary token lasts.
bash
thinger dashboard init greenhouse --to device:YOUR_DEVICE --install
cd greenhouse
npm run build
thinger dashboard publish

thinger dashboard list ​

List dashboard records

text
thinger dashboard list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger dashboard get [options] <dashboard>
ArgumentRequiredDescription
dashboardYesID of the dashboard
OptionDescription
-j, --jsonOutput 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

text
thinger dashboard create [options] [dashboard]
ArgumentRequiredDescription
dashboardNoID of the dashboard
OptionDescription
-j, --jsonOutput 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)

text
thinger dashboard update [options] <dashboard>
ArgumentRequiredDescription
dashboardYesID of the dashboard
OptionDescription
-j, --jsonOutput 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

text
thinger dashboard delete [options] <dashboard>
ArgumentRequiredDescription
dashboardYesID of the dashboard
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger dashboard clone ​

Copy a dashboard under a new id

text
thinger dashboard clone [options] <dashboard> <new-id>
ArgumentRequiredDescription
dashboardYesID of the dashboard
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger dashboard describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger dashboard init ​

Create a dashboard app (TypeScript, on @thinger-io/dashboard-sdk) from a template of the SDK

text
thinger dashboard init [options] <dir>
ArgumentRequiredDescription
dirYesNew or empty folder for the app
OptionDescription
-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
--ciAdd a GitHub workflow that publishes it on every push to main
--installRun npm install
-j, --jsonOutput 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

text
thinger dashboard dev [options] [url]
ArgumentRequiredDescription
urlNoAddress of the app on its dev server (default: dev.url of the manifest)
OptionDescription
--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)
--openOpen the link in the browser
--allow-remoteAllow an app url that is not on this machine (the link carries a full-access token)
--config <file>Manifest (default thinger.json)
-j, --jsonOutput as JSON

thinger dashboard publish ​

Upload an app to a public storage and point dashboards at it

text
thinger dashboard publish [options] [dir]
ArgumentRequiredDescription
dirNoFolder to upload (default: dir of the manifest)
OptionDescription
-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
--pruneDelete files of the storage that are not in this upload
--no-pruneKeep the storage's other files (overrides the manifest)
--bumpMake consoles that have the app open reload it at once
--preview [hours]Also print standalone preview links (read-only, 1 h by default)
--no-pointUpload without pointing the destinations (preview links only)
--config <file>Manifest (default thinger.json)
-j, --jsonOutput as JSON

thinger storage ​

File storages; their files are type storage_file

text
thinger storage [options] [command]
CommandDescription
thinger storage listList storage records
thinger storage getShow a storage as JSON
thinger storage createCreate a storage from --from and --set
thinger storage updateUpdate fields of a storage (fields left out are kept)
thinger storage deleteDelete a storage
thinger storage cloneCopy a storage under a new id
thinger storage describeFields, examples and permissions of a storage, from the server's API
thinger storage fileFiles of a file storage

thinger storage list ​

List storage records

text
thinger storage list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger storage get [options] <storage>
ArgumentRequiredDescription
storageYesID of the storage
OptionDescription
-j, --jsonOutput 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

text
thinger storage create [options] [storage]
ArgumentRequiredDescription
storageNoID of the storage
OptionDescription
-j, --jsonOutput 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)

text
thinger storage update [options] <storage>
ArgumentRequiredDescription
storageYesID of the storage
OptionDescription
-j, --jsonOutput 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

text
thinger storage delete [options] <storage>
ArgumentRequiredDescription
storageYesID of the storage
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger storage clone ​

Copy a storage under a new id

text
thinger storage clone [options] <storage> <new-id>
ArgumentRequiredDescription
storageYesID of the storage
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger storage describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger storage file ​

Files of a file storage

text
thinger storage file [options] [command]
CommandDescription
thinger storage file listList the files of a storage, or of a folder in it
thinger storage file deleteDelete a file of a storage
thinger storage file uploadUpload a local file or folder (binary too), overwriting what is there; folders on the way are created
thinger storage file downloadDownload 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

text
thinger storage file list [options] <storage> [folder]
ArgumentRequiredDescription
storageYesFile storage ID
folderNoFolder of the storage to list (default: all the files)
OptionDescription
-j, --jsonOutput as JSON

thinger storage file delete ​

Delete a file of a storage

text
thinger storage file delete [options] <storage> <path>
ArgumentRequiredDescription
storageYesFile storage ID
pathYesPath of the file in the storage
OptionDescription
-y, --yesDo not ask for confirmation
-j, --jsonOutput as JSON

thinger storage file upload ​

Upload a local file or folder (binary too), overwriting what is there; folders on the way are created

text
thinger storage file upload [options] <storage> <local>
ArgumentRequiredDescription
storageYesFile storage ID
localYesLocal file or folder
OptionDescription
--to <path>Where in the storage: a file path, or the folder for a folder
-j, --jsonOutput as JSON

thinger storage file download ​

Download a file: to -o, or printed (text) / piped (binary)

text
thinger storage file download [options] <storage> <path>
ArgumentRequiredDescription
storageYesFile storage ID
pathYesPath of the file in the storage
OptionDescription
-o, --output <file>Write it to this file
-j, --jsonOutput as JSON

thinger plugin ​

Plugins installed on the account: containers that add features (integrations, apps); their API is reached with thinger plugin call

text
thinger plugin [options] [command]
CommandDescription
thinger plugin listList plugin records
thinger plugin getShow a plugin as JSON
thinger plugin describeFields, examples and permissions of a plugin, from the server's API
thinger plugin callCall the API a plugin serves, at its own path
thinger plugin installInstall 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 upgradeUpgrade the plugin to query {version} (default master); the body holds its settings. The container is recreated stopped (volumes kept): start it next
thinger plugin uninstallUninstall the plugin: removes its container, files, volumes (its data) and properties
thinger plugin startStart the plugin container
thinger plugin stopStop the plugin container
thinger plugin restartRestart the plugin container
thinger plugin pausePause the plugin container
thinger plugin unpauseResume a paused plugin container
thinger plugin killKill the plugin container
thinger plugin publicMake the plugin's web interface reachable without signing in
thinger plugin privateMake the plugin's web interface require signing in again
thinger plugin propertyProperties of a plugin, usually its configuration

thinger plugin list ​

List plugin records

text
thinger plugin list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger plugin get [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-j, --jsonOutput 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

text
thinger plugin describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger plugin call ​

Call the API a plugin serves, at its own path

text
thinger plugin call [options] <plugin> [path]
ArgumentRequiredDescription
pluginYesPlugin ID
pathNoPath in the API of the plugin, e.g. /api/status
OptionDescription
-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, --jsonOutput 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

text
thinger plugin install [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin upgrade [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin uninstall [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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, --yesDo not ask for confirmation

thinger plugin start ​

Start the plugin container

text
thinger plugin start [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin stop [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin restart [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin pause [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin unpause [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin kill [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin public [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin private [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-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, --jsonOutput 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

text
thinger plugin property [options] [command]
CommandDescription
thinger plugin property listList plugin property records
thinger plugin property getShow a plugin property as JSON
thinger plugin property createCreate a plugin property from --from and --set
thinger plugin property updateUpdate fields of a plugin property (fields left out are kept)
thinger plugin property deleteDelete a plugin property
thinger plugin property cloneCopy a plugin property under a new id
thinger plugin property setSet the value of a plugin property (created when missing)
thinger plugin property describeFields, examples and permissions of a plugin property, from the server's API

thinger plugin property list ​

List plugin property records

text
thinger plugin property list [options] <plugin>
ArgumentRequiredDescription
pluginYesID of the plugin
OptionDescription
-j, --jsonOutput 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

text
thinger plugin property get [options] <plugin> <property>
ArgumentRequiredDescription
pluginYesID of the plugin
propertyYesID of the plugin property
OptionDescription
-j, --jsonOutput 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

text
thinger plugin property create [options] <plugin> [property]
ArgumentRequiredDescription
pluginYesID of the plugin
propertyNoID of the plugin property
OptionDescription
-j, --jsonOutput 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)

text
thinger plugin property update [options] <plugin> <property>
ArgumentRequiredDescription
pluginYesID of the plugin
propertyYesID of the plugin property
OptionDescription
-j, --jsonOutput 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)
--mergePatch the value (JSON merge) instead of replacing it

thinger plugin property delete ​

Delete a plugin property

text
thinger plugin property delete [options] <plugin> <property>
ArgumentRequiredDescription
pluginYesID of the plugin
propertyYesID of the plugin property
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger plugin property clone ​

Copy a plugin property under a new id

text
thinger plugin property clone [options] <plugin> <property> <new-id>
ArgumentRequiredDescription
pluginYesID of the plugin
propertyYesID of the plugin property
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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)

text
thinger plugin property set [options] <plugin> <property> <value>
ArgumentRequiredDescription
pluginYesID of the plugin
propertyYesID of the plugin property
valueYesValue, parsed as JSON (text when it is not JSON)
OptionDescription
-j, --jsonOutput as JSON

thinger plugin property describe ​

Fields, examples and permissions of a plugin property, from the server's API

text
thinger plugin property describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger endpoint ​

Endpoints: outgoing HTTP calls, emails, notifications (run one with its call action)

text
thinger endpoint [options] [command]
CommandDescription
thinger endpoint listList endpoint records
thinger endpoint getShow an endpoint as JSON
thinger endpoint createCreate an endpoint from --from and --set
thinger endpoint updateUpdate fields of an endpoint (fields left out are kept)
thinger endpoint deleteDelete an endpoint
thinger endpoint cloneCopy an endpoint under a new id
thinger endpoint describeFields, examples and permissions of an endpoint, from the server's API
thinger endpoint callRun the endpoint with the body as its payload (its templates see it as {{payload}}); returns what it answered

thinger endpoint list ​

List endpoint records

text
thinger endpoint list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger endpoint get [options] <endpoint>
ArgumentRequiredDescription
endpointYesID of the endpoint
OptionDescription
-j, --jsonOutput 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

text
thinger endpoint create [options] [endpoint]
ArgumentRequiredDescription
endpointNoID of the endpoint
OptionDescription
-j, --jsonOutput 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)

text
thinger endpoint update [options] <endpoint>
ArgumentRequiredDescription
endpointYesID of the endpoint
OptionDescription
-j, --jsonOutput 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

text
thinger endpoint delete [options] <endpoint>
ArgumentRequiredDescription
endpointYesID of the endpoint
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger endpoint clone ​

Copy an endpoint under a new id

text
thinger endpoint clone [options] <endpoint> <new-id>
ArgumentRequiredDescription
endpointYesID of the endpoint
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger endpoint describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger endpoint call ​

Run the endpoint with the body as its payload (its templates see it as {{payload}}); returns what it answered

text
thinger endpoint call [options] <endpoint>
ArgumentRequiredDescription
endpointYesID of the endpoint
OptionDescription
-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, --jsonOutput 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

text
thinger asset [options] [command]
CommandDescription
thinger asset typeAsset types: a category of device (e.g. "boiler"), with its own properties
thinger asset groupAsset 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

text
thinger asset type [options] [command]
CommandDescription
thinger asset type listList asset type records
thinger asset type getShow an asset type as JSON
thinger asset type createCreate an asset type from --from and --set
thinger asset type updateUpdate fields of an asset type (fields left out are kept)
thinger asset type deleteDelete an asset type
thinger asset type cloneCopy an asset type under a new id
thinger asset type describeFields, examples and permissions of an asset type, from the server's API
thinger asset type propertyProperties of an asset type

thinger asset type list ​

List asset type records

text
thinger asset type list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger asset type get [options] <type>
ArgumentRequiredDescription
typeYesID of the asset type
OptionDescription
-j, --jsonOutput 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

text
thinger asset type create [options] [type]
ArgumentRequiredDescription
typeNoID of the asset type
OptionDescription
-j, --jsonOutput 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)

text
thinger asset type update [options] <type>
ArgumentRequiredDescription
typeYesID of the asset type
OptionDescription
-j, --jsonOutput 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

text
thinger asset type delete [options] <type>
ArgumentRequiredDescription
typeYesID of the asset type
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger asset type clone ​

Copy an asset type under a new id

text
thinger asset type clone [options] <type> <new-id>
ArgumentRequiredDescription
typeYesID of the asset type
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger asset type describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger asset type property ​

Properties of an asset type

text
thinger asset type property [options] [command]
CommandDescription
thinger asset type property listList asset type property records
thinger asset type property getShow an asset type property as JSON
thinger asset type property createCreate an asset type property from --from and --set
thinger asset type property updateUpdate fields of an asset type property (fields left out are kept)
thinger asset type property deleteDelete an asset type property
thinger asset type property cloneCopy an asset type property under a new id
thinger asset type property setSet the value of an asset type property (created when missing)
thinger asset type property describeFields, examples and permissions of an asset type property, from the server's API

thinger asset type property list ​

List asset type property records

text
thinger asset type property list [options] <type>
ArgumentRequiredDescription
typeYesID of the asset type
OptionDescription
-j, --jsonOutput 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

text
thinger asset type property get [options] <type> <property>
ArgumentRequiredDescription
typeYesID of the asset type
propertyYesID of the asset type property
OptionDescription
-j, --jsonOutput 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

text
thinger asset type property create [options] <type> [property]
ArgumentRequiredDescription
typeYesID of the asset type
propertyNoID of the asset type property
OptionDescription
-j, --jsonOutput 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)

text
thinger asset type property update [options] <type> <property>
ArgumentRequiredDescription
typeYesID of the asset type
propertyYesID of the asset type property
OptionDescription
-j, --jsonOutput 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)
--mergePatch the value (JSON merge) instead of replacing it

thinger asset type property delete ​

Delete an asset type property

text
thinger asset type property delete [options] <type> <property>
ArgumentRequiredDescription
typeYesID of the asset type
propertyYesID of the asset type property
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger asset type property clone ​

Copy an asset type property under a new id

text
thinger asset type property clone [options] <type> <property> <new-id>
ArgumentRequiredDescription
typeYesID of the asset type
propertyYesID of the asset type property
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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)

text
thinger asset type property set [options] <type> <property> <value>
ArgumentRequiredDescription
typeYesID of the asset type
propertyYesID of the asset type property
valueYesValue, parsed as JSON (text when it is not JSON)
OptionDescription
-j, --jsonOutput as JSON

thinger asset type property describe ​

Fields, examples and permissions of an asset type property, from the server's API

text
thinger asset type property describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger asset group ​

Asset groups: a set of devices (e.g. a site), with its own properties

text
thinger asset group [options] [command]
CommandDescription
thinger asset group listList asset group records
thinger asset group getShow an asset group as JSON
thinger asset group createCreate an asset group from --from and --set
thinger asset group updateUpdate fields of an asset group (fields left out are kept)
thinger asset group deleteDelete an asset group
thinger asset group cloneCopy an asset group under a new id
thinger asset group describeFields, examples and permissions of an asset group, from the server's API
thinger asset group propertyProperties of an asset group

thinger asset group list ​

List asset group records

text
thinger asset group list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger asset group get [options] <group>
ArgumentRequiredDescription
groupYesID of the asset group
OptionDescription
-j, --jsonOutput 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

text
thinger asset group create [options] [group]
ArgumentRequiredDescription
groupNoID of the asset group
OptionDescription
-j, --jsonOutput 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)

text
thinger asset group update [options] <group>
ArgumentRequiredDescription
groupYesID of the asset group
OptionDescription
-j, --jsonOutput 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

text
thinger asset group delete [options] <group>
ArgumentRequiredDescription
groupYesID of the asset group
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger asset group clone ​

Copy an asset group under a new id

text
thinger asset group clone [options] <group> <new-id>
ArgumentRequiredDescription
groupYesID of the asset group
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger asset group describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger asset group property ​

Properties of an asset group

text
thinger asset group property [options] [command]
CommandDescription
thinger asset group property listList asset group property records
thinger asset group property getShow an asset group property as JSON
thinger asset group property createCreate an asset group property from --from and --set
thinger asset group property updateUpdate fields of an asset group property (fields left out are kept)
thinger asset group property deleteDelete an asset group property
thinger asset group property cloneCopy an asset group property under a new id
thinger asset group property setSet the value of an asset group property (created when missing)
thinger asset group property describeFields, examples and permissions of an asset group property, from the server's API

thinger asset group property list ​

List asset group property records

text
thinger asset group property list [options] <group>
ArgumentRequiredDescription
groupYesID of the asset group
OptionDescription
-j, --jsonOutput 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

text
thinger asset group property get [options] <group> <property>
ArgumentRequiredDescription
groupYesID of the asset group
propertyYesID of the asset group property
OptionDescription
-j, --jsonOutput 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

text
thinger asset group property create [options] <group> [property]
ArgumentRequiredDescription
groupYesID of the asset group
propertyNoID of the asset group property
OptionDescription
-j, --jsonOutput 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)

text
thinger asset group property update [options] <group> <property>
ArgumentRequiredDescription
groupYesID of the asset group
propertyYesID of the asset group property
OptionDescription
-j, --jsonOutput 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)
--mergePatch the value (JSON merge) instead of replacing it

thinger asset group property delete ​

Delete an asset group property

text
thinger asset group property delete [options] <group> <property>
ArgumentRequiredDescription
groupYesID of the asset group
propertyYesID of the asset group property
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger asset group property clone ​

Copy an asset group property under a new id

text
thinger asset group property clone [options] <group> <property> <new-id>
ArgumentRequiredDescription
groupYesID of the asset group
propertyYesID of the asset group property
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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)

text
thinger asset group property set [options] <group> <property> <value>
ArgumentRequiredDescription
groupYesID of the asset group
propertyYesID of the asset group property
valueYesValue, parsed as JSON (text when it is not JSON)
OptionDescription
-j, --jsonOutput as JSON

thinger asset group property describe ​

Fields, examples and permissions of an asset group property, from the server's API

text
thinger asset group property describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger project ​

Projects: group resources of any type to share them or show them together

text
thinger project [options] [command]
CommandDescription
thinger project listList project records
thinger project getShow a project as JSON
thinger project createCreate a project from --from and --set
thinger project updateUpdate fields of a project (fields left out are kept)
thinger project deleteDelete a project
thinger project cloneCopy a project under a new id
thinger project describeFields, examples and permissions of a project, from the server's API
thinger project propertyProperties of a project
thinger project memberMembers a project is shared with, and their roles
thinger project roleRoles defined inside a project

thinger project list ​

List project records

text
thinger project list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger project get [options] <project>
ArgumentRequiredDescription
projectYesID of the project
OptionDescription
-j, --jsonOutput 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

text
thinger project create [options] [project]
ArgumentRequiredDescription
projectNoID of the project
OptionDescription
-j, --jsonOutput 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)

text
thinger project update [options] <project>
ArgumentRequiredDescription
projectYesID of the project
OptionDescription
-j, --jsonOutput 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

text
thinger project delete [options] <project>
ArgumentRequiredDescription
projectYesID of the project
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger project clone ​

Copy a project under a new id

text
thinger project clone [options] <project> <new-id>
ArgumentRequiredDescription
projectYesID of the project
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger project describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger project property ​

Properties of a project

text
thinger project property [options] [command]
CommandDescription
thinger project property listList project property records
thinger project property getShow a project property as JSON
thinger project property createCreate a project property from --from and --set
thinger project property updateUpdate fields of a project property (fields left out are kept)
thinger project property deleteDelete a project property
thinger project property cloneCopy a project property under a new id
thinger project property setSet the value of a project property (created when missing)
thinger project property describeFields, examples and permissions of a project property, from the server's API

thinger project property list ​

List project property records

text
thinger project property list [options] <project>
ArgumentRequiredDescription
projectYesID of the project
OptionDescription
-j, --jsonOutput 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

text
thinger project property get [options] <project> <property>
ArgumentRequiredDescription
projectYesID of the project
propertyYesID of the project property
OptionDescription
-j, --jsonOutput 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

text
thinger project property create [options] <project> [property]
ArgumentRequiredDescription
projectYesID of the project
propertyNoID of the project property
OptionDescription
-j, --jsonOutput 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)

text
thinger project property update [options] <project> <property>
ArgumentRequiredDescription
projectYesID of the project
propertyYesID of the project property
OptionDescription
-j, --jsonOutput 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)
--mergePatch the value (JSON merge) instead of replacing it

thinger project property delete ​

Delete a project property

text
thinger project property delete [options] <project> <property>
ArgumentRequiredDescription
projectYesID of the project
propertyYesID of the project property
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger project property clone ​

Copy a project property under a new id

text
thinger project property clone [options] <project> <property> <new-id>
ArgumentRequiredDescription
projectYesID of the project
propertyYesID of the project property
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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)

text
thinger project property set [options] <project> <property> <value>
ArgumentRequiredDescription
projectYesID of the project
propertyYesID of the project property
valueYesValue, parsed as JSON (text when it is not JSON)
OptionDescription
-j, --jsonOutput as JSON

thinger project property describe ​

Fields, examples and permissions of a project property, from the server's API

text
thinger project property describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger project member ​

Members a project is shared with, and their roles

text
thinger project member [options] [command]
CommandDescription
thinger project member listList project member records
thinger project member getShow a project member as JSON
thinger project member createCreate a project member from --from and --set
thinger project member updateUpdate fields of a project member (fields left out are kept)
thinger project member deleteDelete a project member
thinger project member describeFields, examples and permissions of a project member, from the server's API

thinger project member list ​

List project member records

text
thinger project member list [options] <project>
ArgumentRequiredDescription
projectYesID of the project
OptionDescription
-j, --jsonOutput 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

text
thinger project member get [options] <project> <member>
ArgumentRequiredDescription
projectYesID of the project
memberYesID of the project member
OptionDescription
-j, --jsonOutput 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

text
thinger project member create [options] <project> [member]
ArgumentRequiredDescription
projectYesID of the project
memberNoID of the project member
OptionDescription
-j, --jsonOutput 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)

text
thinger project member update [options] <project> <member>
ArgumentRequiredDescription
projectYesID of the project
memberYesID of the project member
OptionDescription
-j, --jsonOutput 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

text
thinger project member delete [options] <project> <member>
ArgumentRequiredDescription
projectYesID of the project
memberYesID of the project member
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger project member describe ​

Fields, examples and permissions of a project member, from the server's API

text
thinger project member describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger project role ​

Roles defined inside a project

text
thinger project role [options] [command]
CommandDescription
thinger project role listList project role records
thinger project role getShow a project role as JSON
thinger project role createCreate a project role from --from and --set
thinger project role updateUpdate fields of a project role (fields left out are kept)
thinger project role deleteDelete a project role
thinger project role cloneCopy a project role under a new id
thinger project role describeFields, examples and permissions of a project role, from the server's API

thinger project role list ​

List project role records

text
thinger project role list [options] <project>
ArgumentRequiredDescription
projectYesID of the project
OptionDescription
-j, --jsonOutput 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

text
thinger project role get [options] <project> <role>
ArgumentRequiredDescription
projectYesID of the project
roleYesID of the project role
OptionDescription
-j, --jsonOutput 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

text
thinger project role create [options] <project> [role]
ArgumentRequiredDescription
projectYesID of the project
roleNoID of the project role
OptionDescription
-j, --jsonOutput 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)

text
thinger project role update [options] <project> <role>
ArgumentRequiredDescription
projectYesID of the project
roleYesID of the project role
OptionDescription
-j, --jsonOutput 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

text
thinger project role delete [options] <project> <role>
ArgumentRequiredDescription
projectYesID of the project
roleYesID of the project role
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger project role clone ​

Copy a project role under a new id

text
thinger project role clone [options] <project> <role> <new-id>
ArgumentRequiredDescription
projectYesID of the project
roleYesID of the project role
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger project role describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger token ​

Access tokens of the account, with their permission tree

text
thinger token [options] [command]
CommandDescription
thinger token listList token records
thinger token getShow a token as JSON
thinger token createCreate a token from --from and --set
thinger token updateUpdate fields of a token (fields left out are kept)
thinger token deleteDelete a token
thinger token cloneCopy a token under a new id
thinger token describeFields, examples and permissions of a token, from the server's API

thinger token list ​

List token records

text
thinger token list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger token get [options] <token>
ArgumentRequiredDescription
tokenYesID of the token
OptionDescription
-j, --jsonOutput 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

text
thinger token create [options] [token]
ArgumentRequiredDescription
tokenNoID of the token
OptionDescription
-j, --jsonOutput 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)

text
thinger token update [options] <token>
ArgumentRequiredDescription
tokenYesID of the token
OptionDescription
-j, --jsonOutput 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

text
thinger token delete [options] <token>
ArgumentRequiredDescription
tokenYesID of the token
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger token clone ​

Copy a token under a new id

text
thinger token clone [options] <token> <new-id>
ArgumentRequiredDescription
tokenYesID of the token
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger token describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger alarm ​

Alarms: the rules that watch devices and buckets, and the instances they raise

text
thinger alarm [options] [command]
CommandDescription
thinger alarm ruleAlarm rules: conditions on device or bucket data that raise alarm instances
thinger alarm instanceAlarm 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

text
thinger alarm rule [options] [command]
CommandDescription
thinger alarm rule listList alarm rule records
thinger alarm rule getShow an alarm rule as JSON
thinger alarm rule createCreate an alarm rule from --from and --set
thinger alarm rule updateUpdate fields of an alarm rule (fields left out are kept)
thinger alarm rule deleteDelete an alarm rule
thinger alarm rule cloneCopy an alarm rule under a new id
thinger alarm rule describeFields, examples and permissions of an alarm rule, from the server's API
thinger alarm rule testEvaluate 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-sourceRead 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-notificationSend 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

text
thinger alarm rule list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger alarm rule get [options] <rule>
ArgumentRequiredDescription
ruleYesID of the alarm rule
OptionDescription
-j, --jsonOutput 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

text
thinger alarm rule create [options] [rule]
ArgumentRequiredDescription
ruleNoID of the alarm rule
OptionDescription
-j, --jsonOutput 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)

text
thinger alarm rule update [options] <rule>
ArgumentRequiredDescription
ruleYesID of the alarm rule
OptionDescription
-j, --jsonOutput 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

text
thinger alarm rule delete [options] <rule>
ArgumentRequiredDescription
ruleYesID of the alarm rule
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger alarm rule clone ​

Copy an alarm rule under a new id

text
thinger alarm rule clone [options] <rule> <new-id>
ArgumentRequiredDescription
ruleYesID of the alarm rule
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger alarm rule describe [options]
OptionDescription
-j, --jsonOutput 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

text
thinger alarm rule test [options] <rule>
ArgumentRequiredDescription
ruleYesID of the alarm rule
OptionDescription
-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, --jsonOutput 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)

text
thinger alarm rule test-source [options] <rule>
ArgumentRequiredDescription
ruleYesID of the alarm rule
OptionDescription
-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, --jsonOutput 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

text
thinger alarm rule test-notification [options] <rule>
ArgumentRequiredDescription
ruleYesID of the alarm rule
OptionDescription
-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, --jsonOutput 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

text
thinger alarm instance [options] [command]
CommandDescription
thinger alarm instance listList alarm instance records
thinger alarm instance getShow an alarm instance as JSON
thinger alarm instance updateUpdate fields of an alarm instance (fields left out are kept)
thinger alarm instance deleteDelete an alarm instance
thinger alarm instance describeFields, examples and permissions of an alarm instance, from the server's API
thinger alarm instance statsHow 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

text
thinger alarm instance list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger alarm instance get [options] <instance>
ArgumentRequiredDescription
instanceYesID of the alarm instance
OptionDescription
-j, --jsonOutput 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)

text
thinger alarm instance update [options] <instance>
ArgumentRequiredDescription
instanceYesID of the alarm instance
OptionDescription
-j, --jsonOutput 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

text
thinger alarm instance delete [options] <instance>
ArgumentRequiredDescription
instanceYesID of the alarm instance
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger alarm instance describe ​

Fields, examples and permissions of an alarm instance, from the server's API

text
thinger alarm instance describe [options]
OptionDescription
-j, --jsonOutput 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

text
thinger alarm instance stats [options]
OptionDescription
-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, --jsonOutput as JSON

thinger claim ​

Device claims: codes that let end users take ownership of a device

text
thinger claim [options] [command]
CommandDescription
thinger claim listList claim records
thinger claim getShow a claim as JSON
thinger claim createCreate a claim from --from and --set
thinger claim updateUpdate fields of a claim (fields left out are kept)
thinger claim deleteDelete a claim
thinger claim cloneCopy a claim under a new id
thinger claim describeFields, examples and permissions of a claim, from the server's API

thinger claim list ​

List claim records

text
thinger claim list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger claim get [options] <claim>
ArgumentRequiredDescription
claimYesID of the claim
OptionDescription
-j, --jsonOutput 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

text
thinger claim create [options] [claim]
ArgumentRequiredDescription
claimNoID of the claim
OptionDescription
-j, --jsonOutput 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)

text
thinger claim update [options] <claim>
ArgumentRequiredDescription
claimYesID of the claim
OptionDescription
-j, --jsonOutput 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

text
thinger claim delete [options] <claim>
ArgumentRequiredDescription
claimYesID of the claim
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger claim clone ​

Copy a claim under a new id

text
thinger claim clone [options] <claim> <new-id>
ArgumentRequiredDescription
claimYesID of the claim
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger claim describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger property ​

Account properties: JSON values stored on the account

text
thinger property [options] [command]
CommandDescription
thinger property listList property records
thinger property getShow a property as JSON
thinger property createCreate a property from --from and --set
thinger property updateUpdate fields of a property (fields left out are kept)
thinger property deleteDelete a property
thinger property cloneCopy a property under a new id
thinger property setSet the value of a property (created when missing)
thinger property describeFields, examples and permissions of a property, from the server's API

thinger property list ​

List property records

text
thinger property list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger property get [options] <property>
ArgumentRequiredDescription
propertyYesID of the property
OptionDescription
-j, --jsonOutput 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

text
thinger property create [options] [property]
ArgumentRequiredDescription
propertyNoID of the property
OptionDescription
-j, --jsonOutput 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)

text
thinger property update [options] <property>
ArgumentRequiredDescription
propertyYesID of the property
OptionDescription
-j, --jsonOutput 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)
--mergePatch the value (JSON merge) instead of replacing it

thinger property delete ​

Delete a property

text
thinger property delete [options] <property>
ArgumentRequiredDescription
propertyYesID of the property
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger property clone ​

Copy a property under a new id

text
thinger property clone [options] <property> <new-id>
ArgumentRequiredDescription
propertyYesID of the property
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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)

text
thinger property set [options] <property> <value>
ArgumentRequiredDescription
propertyYesID of the property
valueYesValue, parsed as JSON (text when it is not JSON)
OptionDescription
-j, --jsonOutput as JSON

thinger property describe ​

Fields, examples and permissions of a property, from the server's API

text
thinger property describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger role ​

Roles: named permission sets for project members

text
thinger role [options] [command]
CommandDescription
thinger role listList role records
thinger role getShow a role as JSON
thinger role createCreate a role from --from and --set
thinger role updateUpdate fields of a role (fields left out are kept)
thinger role deleteDelete a role
thinger role cloneCopy a role under a new id
thinger role describeFields, examples and permissions of a role, from the server's API

thinger role list ​

List role records

text
thinger role list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger role get [options] <role>
ArgumentRequiredDescription
roleYesID of the role
OptionDescription
-j, --jsonOutput 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

text
thinger role create [options] [role]
ArgumentRequiredDescription
roleNoID of the role
OptionDescription
-j, --jsonOutput 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)

text
thinger role update [options] <role>
ArgumentRequiredDescription
roleYesID of the role
OptionDescription
-j, --jsonOutput 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

text
thinger role delete [options] <role>
ArgumentRequiredDescription
roleYesID of the role
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger role clone ​

Copy a role under a new id

text
thinger role clone [options] <role> <new-id>
ArgumentRequiredDescription
roleYesID of the role
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger role describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger sync ​

Syncs: shared semaphores with a number of slots that devices or scripts take (locks) to coordinate

text
thinger sync [options] [command]
CommandDescription
thinger sync listList sync records
thinger sync getShow a sync as JSON
thinger sync createCreate a sync from --from and --set
thinger sync updateUpdate fields of a sync (fields left out are kept)
thinger sync deleteDelete a sync
thinger sync cloneCopy a sync under a new id
thinger sync describeFields, examples and permissions of a sync, from the server's API
thinger sync lockLocks of a sync: slots currently taken

thinger sync list ​

List sync records

text
thinger sync list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger sync get [options] <sync>
ArgumentRequiredDescription
syncYesID of the sync
OptionDescription
-j, --jsonOutput 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

text
thinger sync create [options] [sync]
ArgumentRequiredDescription
syncNoID of the sync
OptionDescription
-j, --jsonOutput 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)

text
thinger sync update [options] <sync>
ArgumentRequiredDescription
syncYesID of the sync
OptionDescription
-j, --jsonOutput 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

text
thinger sync delete [options] <sync>
ArgumentRequiredDescription
syncYesID of the sync
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger sync clone ​

Copy a sync under a new id

text
thinger sync clone [options] <sync> <new-id>
ArgumentRequiredDescription
syncYesID of the sync
new-idYesID of the copy
OptionDescription
-j, --jsonOutput 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

text
thinger sync describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger sync lock ​

Locks of a sync: slots currently taken

text
thinger sync lock [options] [command]
CommandDescription
thinger sync lock listList sync lock records
thinger sync lock getShow a sync lock as JSON
thinger sync lock createCreate a sync lock from --from and --set
thinger sync lock updateUpdate fields of a sync lock (fields left out are kept)
thinger sync lock deleteDelete a sync lock
thinger sync lock describeFields, examples and permissions of a sync lock, from the server's API

thinger sync lock list ​

List sync lock records

text
thinger sync lock list [options] <sync>
ArgumentRequiredDescription
syncYesID of the sync
OptionDescription
-j, --jsonOutput 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

text
thinger sync lock get [options] <sync> <lock>
ArgumentRequiredDescription
syncYesID of the sync
lockYesID of the sync lock
OptionDescription
-j, --jsonOutput 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

text
thinger sync lock create [options] <sync> [lock]
ArgumentRequiredDescription
syncYesID of the sync
lockNoID of the sync lock
OptionDescription
-j, --jsonOutput 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)

text
thinger sync lock update [options] <sync> <lock>
ArgumentRequiredDescription
syncYesID of the sync
lockYesID of the sync lock
OptionDescription
-j, --jsonOutput 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

text
thinger sync lock delete [options] <sync> <lock>
ArgumentRequiredDescription
syncYesID of the sync
lockYesID of the sync lock
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger sync lock describe ​

Fields, examples and permissions of a sync lock, from the server's API

text
thinger sync lock describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger admin ​

Server administration (admin accounts): users, hosts, domains, brands…

text
thinger admin [options] [command]
CommandDescription
thinger admin userUser accounts of the server
thinger admin hostHosts of the server cluster
thinger admin domainCustom domains the server answers on
thinger admin brandBrands: the look (and email) of the console on a domain
thinger admin oauth-clientOAuth clients: applications allowed to sign users in against this server
thinger admin identity-providerIdentity providers: external sign-in (OpenID Connect, OAuth) for the console
thinger admin proxyProxies: services the server exposes through its own address

thinger admin user ​

User accounts of the server

text
thinger admin user [options] [command]
CommandDescription
thinger admin user listList user records
thinger admin user getShow an user as JSON
thinger admin user createCreate an user from --from and --set
thinger admin user updateUpdate fields of an user (fields left out are kept)
thinger admin user deleteDelete an user
thinger admin user describeFields, examples and permissions of an user, from the server's API

thinger admin user list ​

List user records

text
thinger admin user list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger admin user get [options] <user>
ArgumentRequiredDescription
userYesID of the user
OptionDescription
-j, --jsonOutput 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

text
thinger admin user create [options] [user]
ArgumentRequiredDescription
userNoID of the user
OptionDescription
-j, --jsonOutput 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)

text
thinger admin user update [options] <user>
ArgumentRequiredDescription
userYesID of the user
OptionDescription
-j, --jsonOutput 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

text
thinger admin user delete [options] <user>
ArgumentRequiredDescription
userYesID of the user
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger admin user describe ​

Fields, examples and permissions of an user, from the server's API

text
thinger admin user describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger admin host ​

Hosts of the server cluster

text
thinger admin host [options] [command]
CommandDescription
thinger admin host listList host records
thinger admin host getShow a host as JSON
thinger admin host createCreate a host from --from and --set
thinger admin host updateUpdate fields of a host (fields left out are kept)
thinger admin host deleteDelete a host
thinger admin host describeFields, examples and permissions of a host, from the server's API
thinger admin host logsThe 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 restartRestart the host: its devices and users lose the connection meanwhile
thinger admin host get-settingsRead the host settings
thinger admin host update-settingsPatch 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

text
thinger admin host list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger admin host get [options] <host>
ArgumentRequiredDescription
hostYesID of the host
OptionDescription
-j, --jsonOutput 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

text
thinger admin host create [options] [host]
ArgumentRequiredDescription
hostNoID of the host
OptionDescription
-j, --jsonOutput 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)

text
thinger admin host update [options] <host>
ArgumentRequiredDescription
hostYesID of the host
OptionDescription
-j, --jsonOutput 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

text
thinger admin host delete [options] <host>
ArgumentRequiredDescription
hostYesID of the host
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger admin host describe ​

Fields, examples and permissions of a host, from the server's API

text
thinger admin host describe [options]
OptionDescription
-j, --jsonOutput 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

text
thinger admin host logs [options] <host>
ArgumentRequiredDescription
hostYesID of the host
OptionDescription
-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, --jsonOutput as JSON

thinger admin host restart ​

Restart the host: its devices and users lose the connection meanwhile

text
thinger admin host restart [options] <host>
ArgumentRequiredDescription
hostYesID of the host
OptionDescription
-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, --jsonOutput 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, --yesDo not ask for confirmation

thinger admin host get-settings ​

Read the host settings

text
thinger admin host get-settings [options] <host>
ArgumentRequiredDescription
hostYesID of the host
OptionDescription
-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, --jsonOutput 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

text
thinger admin host update-settings [options] <host>
ArgumentRequiredDescription
hostYesID of the host
OptionDescription
-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, --jsonOutput 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

text
thinger admin domain [options] [command]
CommandDescription
thinger admin domain listList domain records
thinger admin domain getShow a domain as JSON
thinger admin domain createCreate a domain from --from and --set
thinger admin domain updateUpdate fields of a domain (fields left out are kept)
thinger admin domain deleteDelete a domain
thinger admin domain describeFields, examples and permissions of a domain, from the server's API
thinger admin domain verifyCheck that the domain resolves to this server (after the user configures its DNS)

thinger admin domain list ​

List domain records

text
thinger admin domain list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger admin domain get [options] <domain>
ArgumentRequiredDescription
domainYesID of the domain
OptionDescription
-j, --jsonOutput 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

text
thinger admin domain create [options] [domain]
ArgumentRequiredDescription
domainNoID of the domain
OptionDescription
-j, --jsonOutput 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)

text
thinger admin domain update [options] <domain>
ArgumentRequiredDescription
domainYesID of the domain
OptionDescription
-j, --jsonOutput 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

text
thinger admin domain delete [options] <domain>
ArgumentRequiredDescription
domainYesID of the domain
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger admin domain describe ​

Fields, examples and permissions of a domain, from the server's API

text
thinger admin domain describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger admin domain verify ​

Check that the domain resolves to this server (after the user configures its DNS)

text
thinger admin domain verify [options] <domain>
ArgumentRequiredDescription
domainYesID of the domain
OptionDescription
-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, --jsonOutput 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

text
thinger admin brand [options] [command]
CommandDescription
thinger admin brand listList brand records
thinger admin brand getShow a brand as JSON
thinger admin brand createCreate a brand from --from and --set
thinger admin brand updateUpdate fields of a brand (fields left out are kept)
thinger admin brand deleteDelete a brand
thinger admin brand describeFields, examples and permissions of a brand, from the server's API
thinger admin brand test-emailSend a test email with the brand's email settings

thinger admin brand list ​

List brand records

text
thinger admin brand list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger admin brand get [options] <brand>
ArgumentRequiredDescription
brandYesID of the brand
OptionDescription
-j, --jsonOutput 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

text
thinger admin brand create [options] [brand]
ArgumentRequiredDescription
brandNoID of the brand
OptionDescription
-j, --jsonOutput 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)

text
thinger admin brand update [options] <brand>
ArgumentRequiredDescription
brandYesID of the brand
OptionDescription
-j, --jsonOutput 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)
--mergePatch the value (JSON merge) instead of replacing it

thinger admin brand delete ​

Delete a brand

text
thinger admin brand delete [options] <brand>
ArgumentRequiredDescription
brandYesID of the brand
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger admin brand describe ​

Fields, examples and permissions of a brand, from the server's API

text
thinger admin brand describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger admin brand test-email ​

Send a test email with the brand's email settings

text
thinger admin brand test-email [options] <brand>
ArgumentRequiredDescription
brandYesID of the brand
OptionDescription
-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, --jsonOutput 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

text
thinger admin oauth-client [options] [command]
CommandDescription
thinger admin oauth-client listList oauth-client records
thinger admin oauth-client getShow an oauth-client as JSON
thinger admin oauth-client createCreate an oauth-client from --from and --set
thinger admin oauth-client updateUpdate fields of an oauth-client (fields left out are kept)
thinger admin oauth-client deleteDelete an oauth-client
thinger admin oauth-client describeFields, examples and permissions of an oauth-client, from the server's API

thinger admin oauth-client list ​

List oauth-client records

text
thinger admin oauth-client list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger admin oauth-client get [options] <oauth-client>
ArgumentRequiredDescription
oauth-clientYesID of the oauth client
OptionDescription
-j, --jsonOutput 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

text
thinger admin oauth-client create [options] [oauth-client]
ArgumentRequiredDescription
oauth-clientNoID of the oauth client
OptionDescription
-j, --jsonOutput 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)

text
thinger admin oauth-client update [options] <oauth-client>
ArgumentRequiredDescription
oauth-clientYesID of the oauth client
OptionDescription
-j, --jsonOutput 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

text
thinger admin oauth-client delete [options] <oauth-client>
ArgumentRequiredDescription
oauth-clientYesID of the oauth client
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger admin oauth-client describe ​

Fields, examples and permissions of an oauth-client, from the server's API

text
thinger admin oauth-client describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger admin identity-provider ​

Identity providers: external sign-in (OpenID Connect, OAuth) for the console

text
thinger admin identity-provider [options] [command]
CommandDescription
thinger admin identity-provider listList identity-provider records
thinger admin identity-provider getShow an identity-provider as JSON
thinger admin identity-provider createCreate an identity-provider from --from and --set
thinger admin identity-provider updateUpdate fields of an identity-provider (fields left out are kept)
thinger admin identity-provider deleteDelete an identity-provider
thinger admin identity-provider describeFields, examples and permissions of an identity-provider, from the server's API

thinger admin identity-provider list ​

List identity-provider records

text
thinger admin identity-provider list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger admin identity-provider get [options] <identity-provider>
ArgumentRequiredDescription
identity-providerYesID of the identity provider
OptionDescription
-j, --jsonOutput 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

text
thinger admin identity-provider create [options] [identity-provider]
ArgumentRequiredDescription
identity-providerNoID of the identity provider
OptionDescription
-j, --jsonOutput 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)

text
thinger admin identity-provider update [options] <identity-provider>
ArgumentRequiredDescription
identity-providerYesID of the identity provider
OptionDescription
-j, --jsonOutput 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

text
thinger admin identity-provider delete [options] <identity-provider>
ArgumentRequiredDescription
identity-providerYesID of the identity provider
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger admin identity-provider describe ​

Fields, examples and permissions of an identity-provider, from the server's API

text
thinger admin identity-provider describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger admin proxy ​

Proxies: services the server exposes through its own address

text
thinger admin proxy [options] [command]
CommandDescription
thinger admin proxy listList proxy records
thinger admin proxy getShow a proxy as JSON
thinger admin proxy createCreate a proxy from --from and --set
thinger admin proxy updateUpdate fields of a proxy (fields left out are kept)
thinger admin proxy deleteDelete a proxy
thinger admin proxy describeFields, examples and permissions of a proxy, from the server's API

thinger admin proxy list ​

List proxy records

text
thinger admin proxy list [options]
OptionDescription
-j, --jsonOutput 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

text
thinger admin proxy get [options] <proxy>
ArgumentRequiredDescription
proxyYesID of the proxy
OptionDescription
-j, --jsonOutput 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

text
thinger admin proxy create [options] [proxy]
ArgumentRequiredDescription
proxyNoID of the proxy
OptionDescription
-j, --jsonOutput 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)

text
thinger admin proxy update [options] <proxy>
ArgumentRequiredDescription
proxyYesID of the proxy
OptionDescription
-j, --jsonOutput 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

text
thinger admin proxy delete [options] <proxy>
ArgumentRequiredDescription
proxyYesID of the proxy
OptionDescription
-j, --jsonOutput as JSON
-y, --yesDo not ask for confirmation

thinger admin proxy describe ​

Fields, examples and permissions of a proxy, from the server's API

text
thinger admin proxy describe [options]
OptionDescription
-j, --jsonOutput as JSON

thinger login ​

Sign in: re-authenticate the current profile, or create the first one. Use profile add for more servers.

text
thinger login [options]
OptionDescription
--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)
--oauthSign 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

text
thinger logout [options]
OptionDescription
--allForget every profile
--keep-tokenDo not revoke the API token on the server

thinger profile ​

Manage configuration profiles

text
thinger profile [options] [command]
CommandDescription
thinger profile listList configured profiles
thinger profile currentPrint the active profile
thinger profile useSet the default profile
thinger profile addAdd a profile for another server (interactive, or with --server/--username/--token)
thinger profile deleteRemove a profile

thinger profile list ​

List configured profiles

text
thinger profile list [options]
OptionDescription
-j, --jsonOutput as JSON

thinger profile current ​

Print the active profile

text
thinger profile current [options]
OptionDescription
-j, --jsonOutput as JSON

thinger profile use ​

Set the default profile

text
thinger profile use [options] <name>
ArgumentRequiredDescription
nameYesProfile name
OptionDescription
-j, --jsonOutput as JSON

thinger profile add ​

Add a profile for another server (interactive, or with --server/--username/--token)

text
thinger profile add [options] [name]
ArgumentRequiredDescription
nameNoProfile name (asked when missing)
OptionDescription
--no-activateDo 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)
--oauthSign in through the browser (OAuth device flow)
--client-id <id>OAuth client id registered on the server
-j, --jsonOutput as JSON

thinger profile delete ​

Remove a profile

text
thinger profile delete [options] <name>
ArgumentRequiredDescription
nameYesProfile name
OptionDescription
-j, --jsonOutput as JSON

thinger api ​

Send a request to the server API (anything the commands do not cover)

text
thinger api [options] <path>
ArgumentRequiredDescription
pathYesAPI path, e.g. /v1/users/{user}/devices ({user}: your account)
OptionDescription
-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, --jsonOutput as JSON ({ ok, data })

thinger doc ​

Guides for agents and app developers: the platform, product code, the dashboard SDK, this CLI

text
thinger doc [options] [command]
CommandDescription
thinger doc listList the guides: the platform, product code, the dashboard SDK, this CLI
thinger doc getPrint a guide (Markdown), whole

thinger doc list ​

List the guides: the platform, product code, the dashboard SDK, this CLI

text
thinger doc list [options]
OptionDescription
-j, --jsonOutput as JSON

thinger doc get ​

Print a guide (Markdown), whole

text
thinger doc get [options] <doc>
ArgumentRequiredDescription
docYesID of the guide (doc list gives them)
OptionDescription
-o, --output <file>Write it to a file
-j, --jsonOutput as JSON

thinger mcp ​

Start the MCP server (stdio) for AI tool integration

text
thinger mcp [options]
OptionDescription
--read-onlyServe 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:

bash
claude mcp add --scope user thinger -- thinger mcp

thinger 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.

See also ​