Skip to content

docs(quickstart): port login + no-api guidance to markdown docs #1081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidberenstein1957 merged 1 commit into from
Feb 27, 2026
Merged

docs(quickstart): port login + no-api guidance to markdown docs #1081

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/getting-started/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ codecarbon config

[![Init config](https://asciinema.org/a/667970.svg){.align-center}](https://asciinema.org/a/667970)

Then login from your terminal to authenticate CLI/API usage:

``` console
codecarbon login
```

You can use the same command to modify an existing config :

[![Modify config](https://asciinema.org/a/667971.svg){.align-center}](https://asciinema.org/a/667971)
Expand All @@ -33,6 +39,13 @@ codecarbon monitor

You have to stop the monitoring manually with `Ctrl+C`.

If you only need local measurement and do not want to send data to the API,
use:

``` console
codecarbon monitor --no-api
```

If you want to detect the hardware of your computer without starting any
measurement, you can use:

Expand Down
Loading