Command examples

Explore the Command Map or find a command below. Examples use placeholder IDs and paths. Review request files and dry-run output before running commands that change local or provider state.

guildscribe capabilitiesCopy Anchor Link

Inspect local readiness and optional live Discord permissions.

guildscribe capabilities

Example:

guildscribe capabilities

Replace example IDs and paths with your own values.

Options:

• --live: check Discord without mutations
• --channel <ID>: channel permission scope

Read the guide.

guildscribe messages sendCopy Anchor Link

Send text or embeds to a Discord channel.

guildscribe messages send

Example:

guildscribe messages send --request messages-send.json --dry-run

File: messages-send.json

{
  "channelID": "333333333333333333",
  "message": {
    "content": "The meeting notes are ready."
  }
}

Save as messages-send.json. Replace the channel ID and message text. The dry run validates the request without sending it.

Options:

• --request <file-or-dash>: JSON request file or stdin (required)
• --dry-run: validate without sending

Request schema: messages.send.request. See the schema reference.

Read the guide.

guildscribe commands syncCopy Anchor Link

Register configured guild slash commands.

guildscribe commands sync

Example:

guildscribe commands sync --dry-run

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Options:

• --dry-run: preview registration

Read the guide.

guildscribe messages listCopy Anchor Link

Browse stored messages.

guildscribe messages list

Example:

guildscribe messages list

Replace example IDs and paths with your own values.

Options:

• --channel <ID>: channel ID
• --after <timestamp>: inclusive ISO timestamp
• --before <timestamp>: exclusive ISO timestamp
• --limit <count>: page size from 1 to 200
• --cursor <cursor>: next page cursor
• --author <ID>: author ID
• --include-threads: include child threads of the selected channel

Read the guide.

guildscribe messages getCopy Anchor Link

Read one stored message.

guildscribe messages get <messageID>

Example:

guildscribe messages get MESSAGE_ID

Replace example IDs and paths with your own values.

Read the guide.

guildscribe messages searchCopy Anchor Link

Search message text.

guildscribe messages search <query>

Example:

guildscribe messages search budget

Replace example IDs and paths with your own values.

Options:

• --channel <ID>: channel ID
• --after <timestamp>: inclusive ISO timestamp
• --before <timestamp>: exclusive ISO timestamp
• --limit <count>: page size from 1 to 200
• --cursor <cursor>: next page cursor
• --author <ID>: author ID
• --include-threads: include child threads of the selected channel

Read the guide.

guildscribe transcript getCopy Anchor Link

Read transcript metadata and optional segments.

guildscribe transcript get <recordingID>

Example:

guildscribe transcript get RECORDING_ID

Replace example IDs and paths with your own values.

Options:

• --include-segments: include a page of transcript segments
• --limit <count>: segment page size from 1 to 200
• --cursor <cursor>: next segment page

Read the guide.

guildscribe transcript searchCopy Anchor Link

Search spoken text.

guildscribe transcript search <query>

Example:

guildscribe transcript search budget

Replace example IDs and paths with your own values.

Options:

• --channel <ID>: channel ID
• --after <timestamp>: inclusive ISO timestamp
• --before <timestamp>: exclusive ISO timestamp
• --limit <count>: page size from 1 to 200
• --cursor <cursor>: next page cursor
• --speaker <ID>: speaker Discord user ID

Read the guide.

guildscribe transcript exportCopy Anchor Link

Export transcript text, JSON, or subtitles.

guildscribe transcript export <recordingID>

Example:

guildscribe transcript export RECORDING_ID --destination /absolute/path/to/new-output --dry-run

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Options:

• --destination <absolute-path>: new export file (required)
• --format <format>: export format
• --dry-run: preview without writing

Read the guide.

guildscribe transcript retryCopy Anchor Link

Queue an explicit retry of failed transcription.

guildscribe transcript retry

Example:

guildscribe transcript retry --request transcript-retry.json --dry-run

File: transcript-retry.json

{
  "recordingID": "00000000-0000-4000-8000-000000000000"
}

Save as transcript-retry.json and replace the example UUID with a recording ID from recordings list. The recording must have a failed transcript. The dry run does not queue work.

Options:

• --request <file-or-dash>: JSON request file or stdin (required)
• --dry-run: preview without queuing

Request schema: transcript.retry.request. See the schema reference.

Read the guide.

guildscribe database statusCopy Anchor Link

Show database version, size, and counts.

guildscribe database status

Example:

guildscribe database status

Replace example IDs and paths with your own values.

Read the guide.

guildscribe database verifyCopy Anchor Link

Check database and search index integrity.

guildscribe database verify

Example:

guildscribe database verify

Replace example IDs and paths with your own values.

Read the guide.

guildscribe database backupCopy Anchor Link

Create a consistent database backup.

guildscribe database backup

Example:

guildscribe database backup --destination /absolute/path/to/new-output --dry-run

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Options:

• --destination <absolute-path>: new SQLite backup file (required)
• --dry-run: preview without writing

Read the guide.

guildscribe helpCopy Anchor Link

List commands and their machine-readable contracts.

guildscribe help [scope...]

Example:

guildscribe help

Replace example IDs and paths with your own values.

Read the guide.

guildscribe versionCopy Anchor Link

Print version and protocol information.

guildscribe version

Example:

guildscribe version

Replace example IDs and paths with your own values.

Read the guide.

guildscribe initCopy Anchor Link

Create a new Guildscribe runtime home.

guildscribe init

Example:

guildscribe init --request init.json --dry-run

File: init.json

{
  "discordToken": "REPLACE_WITH_YOUR_DISCORD_BOT_TOKEN",
  "voiceChannelIDs": [
    "222222222222222222"
  ],
  "messageChannelIDs": [
    "333333333333333333"
  ]
}

Save as init.json outside the repository with owner-only permissions. Replace the token placeholder and channel IDs. The dry run creates no files; initialization refuses to overwrite an existing configuration.

Options:

• --request <file-or-dash>: JSON request file or - for stdin (required)
• --dry-run: validate without writing

Request schema: init.request. See the schema reference.

Read the guide.

guildscribe doctorCopy Anchor Link

Validate local tools, configuration, Discord, and contracts.

guildscribe doctor

Example:

guildscribe doctor --schema init.request

Replace example IDs and paths with your own values.

Options:

• --schema <name>: include one published JSON schema

Read the guide.

guildscribe statusCopy Anchor Link

Show daemon, recording, and storage status.

guildscribe status

Example:

guildscribe status

Replace example IDs and paths with your own values.

Read the guide.

guildscribe config showCopy Anchor Link

Show configuration with the Discord token redacted.

guildscribe config show

Example:

guildscribe config show

Replace example IDs and paths with your own values.

Read the guide.

guildscribe config updateCopy Anchor Link

Atomically update configuration.

guildscribe config update

Example:

guildscribe config update --request config-update.json --dry-run

File: config-update.json

{
  "voiceChannelIDs": [
    "222222222222222222"
  ],
  "messageChannelIDs": [
    "333333333333333333"
  ],
  "emptyGraceMs": 30000
}

Save this JSON as config-update.json. Replace the example channel IDs with your Discord channel IDs. The dry run previews the update; after applying it, restart the daemon for changes to take effect.

Options:

• --request <file-or-dash>: JSON request file or - for stdin (required)
• --dry-run: validate and preview without writing

Request schema: config.update.request. See the schema reference.

Read the guide.

guildscribe recordings listCopy Anchor Link

List published and in-progress recordings.

guildscribe recordings list

Example:

guildscribe recordings list

Replace example IDs and paths with your own values.

Read the guide.

guildscribe recordings showCopy Anchor Link

Show one recording and its artifact sizes.

guildscribe recordings show <recordingID>

Example:

guildscribe recordings show RECORDING_ID

Replace example IDs and paths with your own values.

Read the guide.

guildscribe recordings verifyCopy Anchor Link

Validate recording artifacts and calculate checksums.

guildscribe recordings verify <recordingID>

Example:

guildscribe recordings verify RECORDING_ID

Replace example IDs and paths with your own values.

Read the guide.

guildscribe recordings exportCopy Anchor Link

Copy a recording into a portable checksummed directory.

guildscribe recordings export <recordingID>

Example:

guildscribe recordings export RECORDING_ID --destination /absolute/path/to/new-output --dry-run

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Options:

• --destination <absolute-path>: new export directory (required)
• --wav: also render a PCM WAV copy with FFmpeg
• --dry-run: show the export plan without writing

Read the guide.

guildscribe daemon runCopy Anchor Link

Run the recorder in the foreground.

guildscribe daemon run

Example:

guildscribe daemon run

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported. Runs continuously and can record configured Discord channels.

Read the guide.

guildscribe startup installCopy Anchor Link

Install and load the per-user macOS LaunchAgent.

guildscribe startup install

Example:

guildscribe startup install --dry-run

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Options:

• --dry-run: render the LaunchAgent without installing it

Read the guide.

guildscribe startup uninstallCopy Anchor Link

Unload the LaunchAgent and remove its plist.

guildscribe startup uninstall

Example:

guildscribe startup uninstall

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Read the guide.

guildscribe startup statusCopy Anchor Link

Show the LaunchAgent's installed and running state.

guildscribe startup status

Example:

guildscribe startup status

Replace example IDs and paths with your own values.

Read the guide.

guildscribe startup startCopy Anchor Link

Start an installed LaunchAgent.

guildscribe startup start

Example:

guildscribe startup start

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Read the guide.

guildscribe startup stopCopy Anchor Link

Gracefully stop the LaunchAgent until it is started again.

guildscribe startup stop

Example:

guildscribe startup stop

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Read the guide.

guildscribe startup restartCopy Anchor Link

Gracefully stop and start the LaunchAgent.

guildscribe startup restart

Example:

guildscribe startup restart

Replace example IDs and paths with your own values. This command changes local or Discord state; the example previews it where --dry-run is supported.

Read the guide.

guildscribe startup logsCopy Anchor Link

Read recent daemon and LaunchAgent logs.

guildscribe startup logs

Example:

guildscribe startup logs

Replace example IDs and paths with your own values.

Options:

• --lines <count>: lines to return from each log

Read the guide.