Skip to content

docs: add Gladia CLI page under Developer tools - #127

Merged
karamouche merged 2 commits into
mainfrom
remi/cli_doc
Jul 29, 2026
Merged

docs: add Gladia CLI page under Developer tools#127
karamouche merged 2 commits into
mainfrom
remi/cli_doc

Conversation

@remilejeune2

@remilejeune2 remilejeune2 commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Introduce a new documentation section for developer tooling and document installation, usage, and CLI options for gladia-cli.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Gladia CLI guide covering installation, setup, authentication, transcription workflows, supported commands, output formats, and advanced options.
    • Documented language hints, code switching, diarization, model selection, JSON processing, and shell tab completion.
    • Added links to API key setup, the CLI repository, and the pre-recorded speech-to-text quickstart.
    • Added the guide to the Developer Tools section of the documentation navigation.

Introduce a new documentation section for developer tooling and document installation, usage, and CLI options for gladia-cli.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

A new Gladia CLI documentation page covers installation, API key setup, transcription commands, output formats, language options, diarization, shell completion, and next steps. The navigation adds the page under a new Developer tools group.

Changes

Gladia CLI documentation

Layer / File(s) Summary
CLI installation and authentication
chapters/developer-tools/gladia-cli.mdx
Introduces the CLI, documents macOS/Linux and Windows installation, and explains API key configuration methods and precedence.
Transcription commands and options
chapters/developer-tools/gladia-cli.mdx
Documents transcription examples, commands, output formats, language behavior, model selection, and diarization.
Completion and documentation navigation
chapters/developer-tools/gladia-cli.mdx, docs.json
Adds shell completion instructions, next-step links, and a Developer tools navigation entry.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: mfernandez-gladia

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: adding a Gladia CLI documentation page in Developer tools.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch remi/cli_doc

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@chapters/developer-tools/gladia-cli.mdx`:
- Around line 142-149: Complete the zsh setup instructions following the
completion file creation in the documented shell snippet: either add the
required fpath configuration and compinit initialization, or explicitly state
that the installer performs this setup. Ensure the instructions reference the
generated _gladia completion file so users know it will be loaded.
- Around line 47-53: Update the API-key guidance near the command examples to
warn that inline keys in shell commands can leak through history or process
arguments. Remove the literal-key examples for `gladia auth set` and
`--gladia-key`, and instead recommend `GLADIA_API_KEY` or the saved `~/.gladia`
credential path, mentioning flags only generically if needed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9bb20545-1d53-4c93-897b-dd385bd444c8

📥 Commits

Reviewing files that changed from the base of the PR and between d252f11 and edc7494.

📒 Files selected for processing (2)
  • chapters/developer-tools/gladia-cli.mdx
  • docs.json

Comment thread chapters/developer-tools/gladia-cli.mdx
Comment thread chapters/developer-tools/gladia-cli.mdx
@mintlify

mintlify Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
gladia 🟢 Ready View Preview Jul 10, 2026, 1:51 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@karamouche
karamouche merged commit e58c690 into main Jul 29, 2026
7 checks passed
@karamouche
karamouche deleted the remi/cli_doc branch July 29, 2026 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants