Directories
¶
| Path | Synopsis |
|---|---|
|
Package account reads and manages the AudD account (profile, plan, usage, billing links, API token).
|
Package account reads and manages the AudD account (profile, plan, usage, billing links, API token). |
|
Package agent holds what audd offers coding agents: the documentation topics behind `audd docs`, the skill and rules files `audd agent-setup` writes, and the machine-readable command reference behind `audd commands --json`.
|
Package agent holds what audd offers coding agents: the documentation topics behind `audd docs`, the skill and rules files `audd agent-setup` writes, and the machine-readable command reference behind `audd commands --json`. |
|
Package api builds AudD API clients for the CLI: it resolves the token, configures the SDK's HTTP transport, heals a login-fetched token that the API rejects, and turns SDK errors into the CLI's error contract.
|
Package api builds AudD API clients for the CLI: it resolves the token, configures the SDK's HTTP transport, heals a login-fetched token that the API rejects, and turns SDK errors into the CLI's error contract. |
|
Package app holds the state shared by every command (config, secrets, printer, flags), factories for API and account clients, and the hooks that let feature packages plug into each other without import cycles.
|
Package app holds the state shared by every command (config, secrets, printer, flags), factories for API and account clients, and the hooks that let feature packages plug into each other without import cycles. |
|
Package art fetches cover art and draws it in the terminal: with the Kitty graphics protocol, iTerm2 inline images, or sixel when the terminal supports one of them, and with colored half-block characters otherwise.
|
Package art fetches cover art and draws it in the terminal: with the Kitty graphics protocol, iTerm2 inline images, or sixel when the terminal supports one of them, and with colored half-block characters otherwise. |
|
Package cache keeps recognition results (never audio) so the same file or URL is not paid for twice.
|
Package cache keeps recognition results (never audio) so the same file or URL is not paid for twice. |
|
Package cli defines the audd command tree.
|
Package cli defines the audd command tree. |
|
Package config reads and writes ~/.config/audd/config.toml (%APPDATA%\audd\config.toml on Windows) and resolves the API token.
|
Package config reads and writes ~/.config/audd/config.toml (%APPDATA%\audd\config.toml on Windows) and resolves the API token. |
|
Package contract checks the live AudD services against the shapes the CLI relies on.
|
Package contract checks the live AudD services against the shapes the CLI relies on. |
|
Package jobs keeps batch recognitions as resumable jobs and runs them.
|
Package jobs keeps batch recognitions as resumable jobs and runs them. |
|
Package mcpclient is a small Model Context Protocol client for the AudD account service: Streamable HTTP transport, JSON-RPC 2.0, tools/list and tools/call.
|
Package mcpclient is a small Model Context Protocol client for the AudD account service: Streamable HTTP transport, JSON-RPC 2.0, tools/list and tools/call. |
|
Package mcpserver is the local MCP server behind `audd mcp`.
|
Package mcpserver is the local MCP server behind `audd mcp`. |
|
Package media turns command-line arguments into inputs and wraps the local audio tools (ffmpeg, ffprobe, sox).
|
Package media turns command-line arguments into inputs and wraps the local audio tools (ffmpeg, ffprobe, sox). |
|
Package oauth signs the CLI in to the AudD account service: discovery (RFC 9728 protected resource metadata, RFC 8414 server metadata), the pre-registered public client audd-cli, two ways to approve a sign-in (authorization code with PKCE (RFC 7636) through a loopback redirect or a pasted redirect URL, and the device authorization grant (RFC 8628)), refresh under a cross-process file lock, step-up consent for extra scopes, and revocation.
|
Package oauth signs the CLI in to the AudD account service: discovery (RFC 9728 protected resource metadata, RFC 8414 server metadata), the pre-registered public client audd-cli, two ways to approve a sign-in (authorization code with PKCE (RFC 7636) through a loopback redirect or a pasted redirect URL, and the device authorization grant (RFC 8628)), refresh under a cross-process file lock, step-up consent for extra scopes, and revocation. |
|
Package paths locates the per-user directories the CLI stores files in.
|
Package paths locates the per-user directories the CLI stores files in. |
|
Package safety keeps billable work bounded: it requires explicit limits, estimates what a run will cost before it starts, and enforces the --max-requests ceiling.
|
Package safety keeps billable work bounded: it requires explicit limits, estimates what a run will cost before it starts, and enforces the --max-requests ceiling. |
|
Package secrets stores credentials in the OS credential store (macOS Keychain, Windows Credential Manager, Secret Service on Linux) and falls back silently to a 0600 JSON file in the config dir when that store is unavailable, as on headless servers and in containers.
|
Package secrets stores credentials in the OS credential store (macOS Keychain, Windows Credential Manager, Secret Service on Linux) and falls back silently to a 0600 JSON file in the config dir when that store is unavailable, as on headless servers and in containers. |
|
Package store opens the CLI's SQLite databases (results cache, jobs, stream store) with pure-Go SQLite, WAL journaling, and versioned migrations.
|
Package store opens the CLI's SQLite databases (results cache, jobs, stream store) with pure-Go SQLite, WAL journaling, and versioned migrations. |
|
Package streams reads AudD stream results (live longpoll events and the recent-results endpoint), records them into the local stream store, runs the background recorder, and relays plays to a local callback handler.
|
Package streams reads AudD stream results (live longpoll events and the recent-results endpoint), records them into the local stream store, runs the background recorder, and relays plays to a local callback handler. |
|
streamstest
Package streamstest is a fake AudD stream API for tests: stream management methods, longpoll, and the recent-results endpoint.
|
Package streamstest is a fake AudD stream API for tests: stream management methods, longpoll, and the recent-results endpoint. |
|
Package streamstore keeps the plays and stream health events the stream recorder sees, one SQLite database per profile, and answers history, report, and export queries over them.
|
Package streamstore keeps the plays and stream health events the stream recorder sees, one SQLite database per profile, and answers history, report, and export queries over them. |
|
Package testutil has helpers shared by tests: isolated config/cache/data dirs, in-process command runs, and golden files.
|
Package testutil has helpers shared by tests: isolated config/cache/data dirs, in-process command runs, and golden files. |
|
Package tui is the terminal interface: the result card printed after a recognition, the interactive explorer (audd browse), and the now-playing screen.
|
Package tui is the terminal interface: the result card printed after a recognition, the interactive explorer (audd browse), and the now-playing screen. |
|
Package update finds new audd releases, tells people about them at most once a day, and replaces the binary for installs that no package manager owns.
|
Package update finds new audd releases, tells people about them at most once a day, and replaces the binary for installs that no package manager owns. |
Click to show internal directories.
Click to hide internal directories.