Skip to content

Add a doc in the CLI to explain how to run a process #1470

Closed

Description

@benoit-cty

Where does the documentation need improvement?

When I run uvx codecarbon monitor --help it does not explain how to run a command line like explained in https://docs.codecarbon.io/latest/tutorials/cli/#track-any-command

What needs to be changed?
CLI doc in command line.

Activity

  1. Ptraaah commented on Oct 31, 2026

    @Ptraaah

    Hi, I can work on this one. I will check the contributing guide first and draft clearer docs for the monitor command.

  2. PRINCE2-AI commented on Oct 31, 2026

    @PRINCE2-AI
    Contributor

    Opened #1472 for this: it adds the codecarbon monitor -- <command> usage and the tutorial link to monitor --help, plus a test that pins the help text.

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 newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions