Char
General

CLI Reference

Command-line reference for the char CLI

char

Live transcription and audio tools

char [--base-url] [--api-key] [-m] [-l] [--no-color] [--base] [-v] [-q] [-h] [-V] <command>

Global options:

  • --base-url <BASE_URL>
  • --api-key <API_KEY>
  • -m, --model <MODEL>
  • -l, --language <LANGUAGE> (default: en)
  • --no-color
  • --base <DIR>
  • -v, --verbose — Increase logging verbosity
  • -q, --quiet — Decrease logging verbosity

Options:

  • -h, --help — Print help
  • -V, --version — Print version

Subcommands:

  • transcribe — Transcribe an audio file
  • completions — Generate shell completions
  • meetings — Browse past meetings
  • humans — Browse humans (contacts)
  • orgs — Browse organizations
  • export — Export data in various formats

char transcribe

Transcribe an audio file

char transcribe <--input> <-p> [-k] [-o] [-f] [-h] [-V]

Options:

  • --input <FILE>
  • -p, --provider <PROVIDER>
  • -k, --keyword <KEYWORD>
  • -o, --output <FILE>
  • -f, --format <FORMAT> (default: pretty)
  • -h, --help — Print help
  • -V, --version — Print version

char completions

Generate shell completions

char completions [-h] [-V] <shell>

Options:

  • -h, --help — Print help
  • -V, --version — Print version

Arguments:

  • <SHELL>

char meetings

Browse past meetings

char meetings [-h] [-V] <command>

Options:

  • -h, --help — Print help
  • -V, --version — Print version

Subcommands:

  • list — List meetings
  • view — View a specific meeting
  • participants — List participants in a meeting
  • add-participant — Add a participant to a meeting
  • rm-participant — Remove a participant from a meeting

char meetings list

List meetings

char meetings list [-h] [-V]

Options:

  • -h, --help — Print help
  • -V, --version — Print version

char meetings view

View a specific meeting

char meetings view <--id> [-h] [-V]

Options:

  • --id <ID>
  • -h, --help — Print help
  • -V, --version — Print version

char meetings participants

List participants in a meeting

char meetings participants <--id> [-h] [-V]

Options:

  • --id <ID>
  • -h, --help — Print help
  • -V, --version — Print version

char meetings add-participant

Add a participant to a meeting

char meetings add-participant <--meeting> <--human> [-h] [-V]

Options:

  • --meeting <MEETING>
  • --human <HUMAN>
  • -h, --help — Print help
  • -V, --version — Print version

char meetings rm-participant

Remove a participant from a meeting

char meetings rm-participant <--meeting> <--human> [-h] [-V]

Options:

  • --meeting <MEETING>
  • --human <HUMAN>
  • -h, --help — Print help
  • -V, --version — Print version

char humans

Browse humans (contacts)

char humans [-h] [-V] <command>

Options:

  • -h, --help — Print help
  • -V, --version — Print version

Subcommands:

  • list — List all humans
  • add — Add a new human
  • edit — Edit a human
  • show — Show details for a human
  • rm — Remove a human

char humans list

List all humans

char humans list [-f] [-h] [-V]

Options:

  • -f, --format <FORMAT> (default: pretty)
  • -h, --help — Print help
  • -V, --version — Print version

char humans add

Add a new human

char humans add [--email] [--org] [--title] [-h] [-V] <name>

Options:

  • --email <EMAIL>
  • --org <ORG_ID>
  • --title <JOB_TITLE>
  • -h, --help — Print help
  • -V, --version — Print version

Arguments:

  • <NAME>

char humans edit

Edit a human

char humans edit <--id> [--name] [--email] [--org] [--title] [--memo] [-h] [-V]

Options:

  • --id <ID>
  • --name <NAME>
  • --email <EMAIL>
  • --org <ORG_ID>
  • --title <JOB_TITLE>
  • --memo <MEMO>
  • -h, --help — Print help
  • -V, --version — Print version

char humans show

Show details for a human

char humans show <--id> [-f] [-h] [-V]

Options:

  • --id <ID>
  • -f, --format <FORMAT> (default: pretty)
  • -h, --help — Print help
  • -V, --version — Print version

char humans rm

Remove a human

char humans rm <--id> [-h] [-V]

Options:

  • --id <ID>
  • -h, --help — Print help
  • -V, --version — Print version

char orgs

Browse organizations

char orgs [-h] [-V] <command>

Options:

  • -h, --help — Print help
  • -V, --version — Print version

Subcommands:

  • list — List all organizations
  • add — Add a new organization
  • edit — Edit an organization
  • show — Show details for an organization
  • rm — Remove an organization

char orgs list

List all organizations

char orgs list [-f] [-h] [-V]

Options:

  • -f, --format <FORMAT> (default: pretty)
  • -h, --help — Print help
  • -V, --version — Print version

char orgs add

Add a new organization

char orgs add [-h] [-V] <name>

Options:

  • -h, --help — Print help
  • -V, --version — Print version

Arguments:

  • <NAME>

char orgs edit

Edit an organization

char orgs edit <--id> [--name] [-h] [-V]

Options:

  • --id <ID>
  • --name <NAME>
  • -h, --help — Print help
  • -V, --version — Print version

char orgs show

Show details for an organization

char orgs show <--id> [-f] [-h] [-V]

Options:

  • --id <ID>
  • -f, --format <FORMAT> (default: pretty)
  • -h, --help — Print help
  • -V, --version — Print version

char orgs rm

Remove an organization

char orgs rm <--id> [-h] [-V]

Options:

  • --id <ID>
  • -h, --help — Print help
  • -V, --version — Print version

char export

Export data in various formats

char export [-h] [-V] <command>

Options:

  • -h, --help — Print help
  • -V, --version — Print version

Subcommands:

  • meeting — Export a single meeting with all associated data
  • meetings — Export meeting list
  • transcript — Export transcript for a meeting
  • notes — Export notes for a meeting
  • chat — Export chat messages for a meeting
  • humans — Export all contacts
  • orgs — Export all organizations

char export meeting

Export a single meeting with all associated data

char export meeting <--id> [-f] [-o] [-h] [-V]

Options:

  • --id <ID>
  • -f, --format <FORMAT> (default: json)
  • -o, --output <FILE>
  • -h, --help — Print help
  • -V, --version — Print version

char export meetings

Export meeting list

char export meetings [-f] [-o] [-h] [-V]

Options:

  • -f, --format <FORMAT> (default: text)
  • -o, --output <FILE>
  • -h, --help — Print help
  • -V, --version — Print version

char export transcript

Export transcript for a meeting

char export transcript <--meeting> [-f] [-o] [-h] [-V]

Options:

  • --meeting <MEETING>
  • -f, --format <FORMAT> (default: text)
  • -o, --output <FILE>
  • -h, --help — Print help
  • -V, --version — Print version

char export notes

Export notes for a meeting

char export notes <--meeting> [-f] [-o] [-h] [-V]

Options:

  • --meeting <MEETING>
  • -f, --format <FORMAT> (default: markdown)
  • -o, --output <FILE>
  • -h, --help — Print help
  • -V, --version — Print version

char export chat

Export chat messages for a meeting

char export chat <--meeting> [-f] [-o] [-h] [-V]

Options:

  • --meeting <MEETING>
  • -f, --format <FORMAT> (default: markdown)
  • -o, --output <FILE>
  • -h, --help — Print help
  • -V, --version — Print version

char export humans

Export all contacts

char export humans [-f] [-o] [-h] [-V]

Options:

  • -f, --format <FORMAT> (default: text)
  • -o, --output <FILE>
  • -h, --help — Print help
  • -V, --version — Print version

char export orgs

Export all organizations

char export orgs [-f] [-o] [-h] [-V]

Options:

  • -f, --format <FORMAT> (default: text)
  • -o, --output <FILE>
  • -h, --help — Print help
  • -V, --version — Print version