Skip to content

Add CLI documentation page to Electric Cloud docs#4057

Open
balegas wants to merge 2 commits intomainfrom
claude/add-cli-docs-drXE0
Open

Add CLI documentation page to Electric Cloud docs#4057
balegas wants to merge 2 commits intomainfrom
claude/add-cli-docs-drXE0

Conversation

@balegas
Copy link
Copy Markdown
Contributor

@balegas balegas commented Mar 25, 2026

Summary

Added comprehensive documentation for the Electric Cloud CLI, including installation instructions, authentication methods, common usage examples, and reference information.

Changes

  • New documentation page (website/cloud/cli.md): Complete CLI guide covering:

    • Installation via npm and npx
    • Three authentication methods (token flag, environment variable, browser login)
    • Practical examples for provisioning Postgres sync services
    • Per-PR environment setup for CI/CD pipelines
    • Environment variables reference table
    • JSON output support for scripting and automation
  • Updated navigation (website/.vitepress/config.mts): Added CLI link to the Cloud section sidebar navigation

Implementation Details

The documentation follows the existing Electric Cloud docs structure with metadata (title, description, image, outline depth) and includes real-world usage patterns such as creating projects, environments, and services, as well as advanced scenarios like dynamic per-PR environment provisioning in CI/CD workflows.

https://claude.ai/code/session_015Cs3AVXi49dg5x2fo2XrXL

Adds a new docs page for the @electric-sql/cli package covering
installation, authentication methods, common workflows, and
environment variables.

https://claude.ai/code/session_015Cs3AVXi49dg5x2fo2XrXL
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 25, 2026

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit cb2f3d5
🔍 Latest deploy log https://app.netlify.com/projects/electric-next/deploys/69c3dd13329b3400089b576d
😎 Deploy Preview https://deploy-preview-4057--electric-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

- Move browser login to first auth method
- Add durable streams provisioning example
- Mention durable streams in page description

https://claude.ai/code/session_015Cs3AVXi49dg5x2fo2XrXL
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