docs: add Gladia CLI page under Developer tools#127
Open
remilejeune2 wants to merge 2 commits into
Open
Conversation
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>
Contributor
📝 WalkthroughWalkthroughA 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. ChangesGladia CLI documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
chapters/developer-tools/gladia-cli.mdxdocs.json
Comment on lines
+47
to
+53
| Provide your API key in one of three ways (checked in this order): | ||
|
|
||
| ```bash | ||
| export GLADIA_API_KEY=your_key # 1. environment variable | ||
| gladia auth set your_key # 2. saved to ~/.gladia (mode 0600) | ||
| gladia transcribe meeting.wav --gladia-key your_key # 3. per-command flag | ||
| ``` |
Contributor
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Find all mentions of Gladia-related auth/key handling in docs and code.
rg -n --hidden --glob '!node_modules' --glob '!dist' --glob '!build' \
-e 'GLADIA_API_KEY' \
-e -- '--gladia-key' \
-e 'gladia auth set' \
-e 'auth set' \
-e 'API key' \
chapters . 2>/dev/null | sed -n '1,220p'
echo '--- FILE LIST ---'
fd -a -t f -H -I 'gladia' . | sed -n '1,120p'Repository: gladiaio/docs
Length of output: 151
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Inspect the target doc and nearby files.
target='chapters/developer-tools/gladia-cli.mdx'
wc -l "$target"
sed -n '1,140p' "$target"
echo '--- AST OUTLINE IF SUPPORTED ---'
ast-grep outline "$target" --view expanded || trueRepository: gladiaio/docs
Length of output: 5381
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Look for the CLI source or reference docs mentioning prompt/secret-manager/CI injection paths.
rg -n --hidden --glob '!node_modules' --glob '!dist' --glob '!build' \
-e 'secret manager' \
-e 'CI injection' \
-e 'prompt' \
-e 'stdin' \
-e 'env var' \
-e 'GLADIA_API_KEY' \
-e '--gladia-key' \
-e 'gladia auth' \
. 2>/dev/null | sed -n '1,260p'Repository: gladiaio/docs
Length of output: 8794
Avoid inline API-key examples in shell commands. gladia auth set your_key and --gladia-key your_key expose secrets through shell history or process arguments; add a warning and steer users toward GLADIA_API_KEY or the saved ~/.gladia path instead.
🤖 Prompt for 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.
In `@chapters/developer-tools/gladia-cli.mdx` around lines 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.
Comment on lines
+142
to
+149
| # zsh | ||
| mkdir -p ~/.zsh/completions | ||
| gladia completion zsh > ~/.zsh/completions/_gladia | ||
|
|
||
| # fish | ||
| mkdir -p ~/.config/fish/completions | ||
| gladia completion fish > ~/.config/fish/completions/gladia.fish | ||
| ``` |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo '--- file excerpt ---'
nl -ba chapters/developer-tools/gladia-cli.mdx | sed -n '125,175p'
echo
echo '--- search for completion docs and zsh config mentions ---'
rg -n "gladia completion zsh|fpath|compinit|completions" chapters . -g '*.mdx' -g '*.md' -g '*.mdown' -g '*.txt' -g '*.sh' -g '*.yaml' -g '*.yml' || trueRepository: gladiaio/docs
Length of output: 212
🏁 Script executed:
#!/bin/bash
set -euo pipefail
python3 - <<'PY'
from pathlib import Path
path = Path('chapters/developer-tools/gladia-cli.mdx')
lines = path.read_text().splitlines()
for i in range(125, 176):
if i <= len(lines):
print(f"{i:>4}: {lines[i-1]}")
PY
echo
echo '--- repo search ---'
rg -n "gladia completion zsh|fpath|compinit|_gladia|completion fish|completion zsh" . -g '*.mdx' -g '*.md' -g '*.sh' -g '*.yml' -g '*.yaml' || trueRepository: gladiaio/docs
Length of output: 2086
Complete the zsh completion setup. The manual zsh snippet only writes _gladia; add the fpath/compinit setup or say the installer handles it, otherwise the completion file won’t be loaded.
🤖 Prompt for 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.
In `@chapters/developer-tools/gladia-cli.mdx` around lines 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.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduce a new documentation section for developer tooling and document installation, usage, and CLI options for gladia-cli.
Summary by CodeRabbit