Skip to content

docs: add CLI usage to README - #3314

Open
RobertoReale wants to merge 2 commits into
localsend:mainfrom
RobertoReale:docs/add-cli-readme
Open

docs: add CLI usage to README#3314
RobertoReale wants to merge 2 commits into
localsend:mainfrom
RobertoReale:docs/add-cli-readme

Conversation

@RobertoReale

Copy link
Copy Markdown

Description

This PR adds a small section to the \README.md\ (under the Download table) to mention the newly released CLI (Command Line Interface).

Currently, while the CLI was recently published (and available via Winget / GitHub releases), there was no mention of it in the main README, causing users to potentially miss this feature. It also adds a small note about the existing command-line arguments (like --text) for the main GUI app.

@Tienisto

Copy link
Copy Markdown
Member

Have you tried winget?

It should not be available yet: microsoft/winget-pkgs#415597

@Tienisto Tienisto added the documentation Improvements or additions to documentation label Aug 15, 2026
@RobertoReale

Copy link
Copy Markdown
Author

Good catch, thank you! I've updated the PR to remove the Winget installation instruction for now. We can add it back once the package is approved and available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants