Skip to content

README: document the global --env flag #148

Description

@Maxerns

Why this is a good first issue

Every CLI command accepts `--env` (clap global in `crates/cli/src/main.rs`) to override the project's default environment for one invocation. README never mentions it, so people who just learned `sotto env use` will not know they can do `sotto run --env staging -- npm test` without switching.

Copy only. Pairs with #141 (env ls/use/copy) but does not depend on it landing first.

What to do

In README.md, in or just after the environments / Quick start area, add one example:

sotto run --env staging -- npm test
sotto ls --env staging

One sentence: `--env` lasts for that command only; `sotto env use` changes the default.

British English, no em dashes.

Out of scope

Do not change clap flags. Do not document every global option. Do not add a flags table.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions