tinyDialog.com CLI

The tinyDialog.com CLI lets you query projects, surveys, and submitted feedback from a terminal or an AI agent.

Install

Install the CLI with npm (requires Node.js 20 or later):

npm install --global @tinydialog/cli

Alternatively you can download standalone executables (for Windows, MacOS, or Linux) from GitHub: https://github.com/tinyDialog/cli/releases/latest

Authenticate

tinydialog auth

The command opens your tinyDialog settings. Create a CLI API key, then paste it into the prompt. The CLI validates the key and stores it for the active tinyDialog host.

Check the active credential with:

tinydialog auth status

Remove the stored credential with:

tinydialog auth logout

Use an API key in a non-interactive environment

Set TINYDIALOG_CLI_API_KEY before you run the CLI:

export TINYDIALOG_CLI_API_KEY="your-api-key"
tinydialog response list --project "My Website" --format json

In CI, add the key as a secret and expose it as TINYDIALOG_CLI_API_KEY. This variable overrides a stored key and is never written to disk. Remove the variable from the environment to sign out fully.

List projects, surveys, and responses

List projects:

tinydialog project list

List surveys in a project:

tinydialog survey list --project "My Website"

List the latest responses in a project:

tinydialog response list --project "My Website"

List the latest responses for a survey:

tinydialog response list --survey "My Website/Feedback Widget"

The --survey value can be a survey name when you also pass --project, or a combined project/survey value as shown above. You can also select a project or survey by ID with --project-id or --survey-id.

Set a default project

Add a tinydialog entry to your project's package.json:

{
  "name": "my-project",
  "tinydialog": {
    "project": "My Project"
  }
}

When you run the CLI in this project folder, tinydialog response list uses My Project by default. Explicitly pass --project to use another project for one command and overwrite the configured default.

Output and limits

List commands print Markdown by default. Use JSON for scripts and other automation:

tinydialog response list --project "My Website" --format json

Use --limit to control the maximum number of items.

The default limits are 25 projects, 50 surveys, and 10 responses.

Get help

Show all commands:

tinydialog help

Show help for one command:

tinydialog response --help

Use tinydialog --version to print the installed CLI version.

Configuration

Print the configuration directory used by the CLI:

tinydialog config location

Stored credentials are kept in auth.json inside that directory. On macOS and Linux, this is usually ~/.config/tinydialog-cli/auth.json. When XDG_CONFIG_HOME is an absolute path, the CLI uses $XDG_CONFIG_HOME/tinydialog-cli/auth.json. On Windows, it uses %APPDATA%\tinydialog-cli\auth.json.

Source Code

The CLI is open-source, with the code available on GitHub shared under the MIT license.

Repository: https://github.com/tinyDialog/cli

On this page