Skip to main content
This walks through installing the CLI, signing in through the browser, and piping your first command through jq to confirm the JSON envelope.
Prerequisites
  • Node.js 24 or newer (node --version)
  • A TalkValue account with at least one organization
  • jq for the JSON example, or skip the pipe to see the table view

Run your first command

1

Install the CLI

npm install -g @talkvalue/cli
Verify with talkvalue version. Full options: Install.
2

Sign in

talkvalue auth login
The CLI prints a one-time code, opens your default browser to the verification page, and waits for you to confirm. After you approve, it polls until it gets a token, then asks which organization to use. Pass --org <name-or-id> to skip the picker.On success you’ll see ✓ Logged in as you@example.com (Acme Inc.).
3

List people in your workspace

Run a path person list to confirm everything is wired up. Pipe through jq to inspect the JSON envelope:
talkvalue path person list --json | jq '.data[0]'
The first person record appears: id, name, primaryEmail, primaryPhone, company, jobTitle, channels, events, joinedAt. The pagination block follows the array.

What just happened

  • auth login ran the browser sign-in, exchanged the code for an access token, prompted for organization selection, and saved a profile in your system keyring.
  • path person list --json called the dashboard’s people endpoint as the organization you selected.
  • The --json flag forced JSON output. Without a pipe, the CLI defaults to a table. With a pipe (or --json), it switches to JSON automatically. See Output format.

A few more commands to try

# List the next 50 people, sorted by most recent join date
talkvalue path person list --page-size 50 --sort "joinedAt,desc"

# Show your dashboard overview
talkvalue path overview --json | jq '.data | {peopleCount, eventCount, channelCount, newPeopleThisMonth}'

# Export attendees for event 16 to a CSV
talkvalue path event person export 16 > attendees.csv

# Analyze a CSV before importing
talkvalue path import analyze --file contacts.csv --json
Run talkvalue --help for the full command tree, or talkvalue path person list --help for any subcommand.

For AI agents

The CLI is built for both humans and AI coding agents. Every response is structured JSON, and the repo ships ready-to-install skills that wrap each command group. Add them to any agent in one command:
npx skills add https://github.com/talkvalue/cli
See AI agents for the full list.