Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions content/docs/command-reference/studio/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# studio

Set of commands to authorize DVC with Studio and save the token to global [DVC
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's review here in the code carefully if it's authorize or authenticate.

E.g. here https://cli.github.com/manual/gh_auth_login and here https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli it is authenticate.

We should be careful about this terminology.

configuration]: [login](/doc/command-reference/studio/login),
[logout](/doc/command-reference/studio/logout),
[token](/doc/command-reference/studio/token),

[dvc configuration]:
/doc/user-guide/project-structure/configuration#config-file-locations

## Synopsis

```usage
usage: dvc studio [-h] [-q | -v] {login,logout,token} ...

positional arguments:
{login,logout,token} Use `dvc studio CMD --help` to display command-specific help.
login Authenticate DVC with Studio host
logout Logout user from Studio
token View the token dvc uses to contact Studio

options:
-h, --help show this help message and exit
-q, --quiet Be quiet.
-v, --verbose Be verbose.
```

## Description

`dvc studio` authorize dvc with Studio and set the token. When this is set, DVC
uses this to share live experiments and notify Studio about pushed experiments.

## Options

- `-h`, `--help` - show this help message and exit
- `-q`, `--quiet` - Be quiet
- `-v`, `--verbose` - Be verbose
37 changes: 37 additions & 0 deletions content/docs/command-reference/studio/login.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## studio login

Authorize DVC with Studio to save the token to global [DVC configuration].

[dvc configuration]:
/doc/user-guide/project-structure/configuration#config-file-locations

## Synopsis

```usage
usage: dvc studio login [-h] [-q | -v] [-H <hostname>] [-s <scopes>] [-n <name>] [-d]
```

## Description

By default, this command authorize dvc with Studio with default scopes and a
random name as token name.

## Options

- `-h`, `--help` - show this help message and exit
- `-q`, `--quiet` - Be quiet.
- `-v`, `--verbose` - Be verbose.
- `-H <hostname>`, `--hostname <hostname>` - The hostname of the Studio instance
to authenticate with.
- `-s <scopes>`, `--scopes <scopes>` - The scopes for the authentication token.
- `-n NAME`, `--name <name>` - The name of the authentication token. It will be
used to identify token shown in Studio profile.
- `-d`, `--use-device-code` - Use authentication flow based on user code. You
will be presented with user code to enter in browser. DVC will also use this
if it cannot launch browser on your behalf.

## Available scopes

- `EXPERIMENTS` - Experiment operations
- `DATASETS` - Dataset operations
- `MODELS` - Model registry operations
22 changes: 22 additions & 0 deletions content/docs/command-reference/studio/logout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## studio logout

This command helps to log out user from DVC Studio.

## Synopsis

```usage
usage: dvc studio logout [-h] [-q | -v]
```

## Description

`dvc logout` removes the studio token stored from global [DVC configuration].

[dvc configuration]:
/doc/user-guide/project-structure/configuration#config-file-locations

## Options

- `-h`, `--help` - show this help message and exit
- `-q`, `--quiet` - Be quiet.
- `-v`, `--verbose` - Be verbose.
22 changes: 22 additions & 0 deletions content/docs/command-reference/studio/token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## studio token

This command helps to log out user from DVC Studio.

## Synopsis

```usage
usage: dvc studio token [-h] [-q | -v]
```

## Description

`dvc token` shows the studio token stored in global [DVC configuration].

[dvc configuration]:
/doc/user-guide/project-structure/configuration#config-file-locations

## Options

- `-h`, `--help` - show this help message and exit
- `-q`, `--quiet` - Be quiet.
- `-v`, `--verbose` - Be verbose.
23 changes: 23 additions & 0 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,29 @@
"label": "status",
"slug": "status"
},
{
"label": "studio",
"slug": "studio",
"source": "studio/index.md",
"children": [
{
"label": "studio login",
"slug": "login"
},
{
"label": "studio logout",
"slug": "logout"
},
{
"label": "studio logout",
"slug": "logout"
},
{
"label": "studio token",
"slug": "token"
}
]
},
{
"label": "unfreeze",
"slug": "unfreeze"
Expand Down