Skip to content

[DOC] Add CLI section to user documentation. - #12802

Merged
AureliaDolo merged 1 commit into
masterfrom
aurelia/doc/cli
May 26, 2026
Merged

[DOC] Add CLI section to user documentation.#12802
AureliaDolo merged 1 commit into
masterfrom
aurelia/doc/cli

Conversation

@AureliaDolo

Copy link
Copy Markdown
Contributor

Fix #9120

The goal of this new section is to have a searchable overview of what's possible with the client CLI

@AureliaDolo
AureliaDolo marked this pull request as draft May 12, 2026 14:43
Comment thread docs/cli/install_cli.rst
Comment thread docs/cli/device.rst
Comment thread docs/cli/invite.rst Outdated
Comment thread docs/cli/invite.rst Outdated
@AureliaDolo

AureliaDolo commented May 13, 2026

Copy link
Copy Markdown
Contributor Author

For each command provide full example and command template : eg.
parsec-cli invite user <NEW_USER_EMAIL>

Or have a cheatsheet of commonly used commands ?

@AureliaDolo
AureliaDolo force-pushed the aurelia/doc/cli branch 3 times, most recently from a52531a to 1501ee1 Compare May 18, 2026 14:54
Comment thread docs/cli/introduction.rst Outdated
Comment thread docs/cli/device.rst Outdated
Comment thread docs/cli/device.rst Outdated
Comment thread docs/cli/install_cli.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/install_cli.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/first_steps.rst
Comment thread docs/cli/first_steps.rst Outdated
@AureliaDolo
AureliaDolo force-pushed the aurelia/doc/cli branch 7 times, most recently from dfdd36c to 0dd7529 Compare May 20, 2026 14:40
@AureliaDolo
AureliaDolo marked this pull request as ready for review May 20, 2026 14:40
@AureliaDolo
AureliaDolo requested a review from a team as a code owner May 20, 2026 14:40
@AureliaDolo
AureliaDolo force-pushed the aurelia/doc/cli branch 4 times, most recently from 8ba7b9e to 0bc58f0 Compare May 20, 2026 14:52
Comment thread docs/locale/fr/LC_MESSAGES/index.po Outdated
Comment thread docs/cli/introduction.rst Outdated
Comment thread docs/cli/introduction.rst Outdated
Comment thread docs/cli/introduction.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/first_steps.rst Outdated
Comment thread docs/cli/workspace.rst Outdated
Comment thread docs/cli/workspace.rst
Comment thread docs/cli/workspace.rst Outdated
Comment thread docs/cli/workspace.rst Outdated
Comment thread docs/cli/cheat_sheet.rst Outdated
Comment thread docs/cli/install_cli.rst Outdated
@AureliaDolo
AureliaDolo force-pushed the aurelia/doc/cli branch 3 times, most recently from 6eec35a to 0b29f42 Compare May 22, 2026 14:05

@mmmarcos mmmarcos 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.

LGTM. Just one suggestion for the FR title and we can get this merged 🚀

Comment thread docs/locale/fr/LC_MESSAGES/index.po Outdated

@FirelightFlagboy FirelightFlagboy 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.

I'm not kind of this PR because of the maintenance burden it implies but my main blocking point as been resolved.

I still think it would be good to investigate for a way to run the command in the documentation (that could introduce some nice user stories)

Comment thread docs/cli/install_cli.rst Outdated
@AureliaDolo
AureliaDolo force-pushed the aurelia/doc/cli branch 2 times, most recently from 699b505 to dd2302c Compare May 26, 2026 12:05
@AureliaDolo
AureliaDolo enabled auto-merge May 26, 2026 12:06
@AureliaDolo
AureliaDolo added this pull request to the merge queue May 26, 2026
Merged via the queue into master with commit c5b468d May 26, 2026
11 checks passed
@AureliaDolo
AureliaDolo deleted the aurelia/doc/cli branch May 26, 2026 13:12
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.

[CLI] Document the available commands

3 participants