swanlab login

bash

swanlab login [OPTIONS]

选项	描述
`-r`, `--relogin`	重新登录。
`-h`, `--host`	指定SwanLab服务所在的主机。比如`http://localhost:8000`。
`-k`, `--api-key`	指定API Key。如果您不喜欢使用命令行来输入 API 密钥，这将允许自动登录。
`-w`, `--web-host`	指定SwanLab前端所在的Web主机。
`--local`	将登录凭证保存到当前目录下的 `.swanlab/`文件夹，而非用户主目录。

介绍

登录SwanLab账号，以同步实验到云端。

执行下面的命令后，如果第一次登录，会让你填写API_KEY：

bash

swanlab login

登录过一次后，凭证会保存到本地，并覆盖之前登录过的凭证，无需再次通过swanlab.login或swanlab login登录。

如果你不希望凭证保存在本地，请在python脚本中使用swanlab.login()进行登录。

如果你的电脑不太适合命令行粘贴API Key（比如一些Windows CMD）的方式登录，可以使用：

bash

swanlab login -k <api-key>

如果需要登录一个别的账号，则用下面的命令：

bash

swanlab login --relogin

这会让你输入一个新的API Key以重新登录。

bash

swanlab login --host <host>

默认情况下，登录凭证会保存到用户主目录下，对所有项目生效。如果你希望仅在项目级目录中保存登录凭证（保存到当前目录的 .swanlab/ 文件夹），可以使用--local选项：

bash

swanlab login --local

使用--local登录后，SwanLab 会自动在 .swanlab/ 目录下生成 .gitignore 文件，避免凭证被意外提交到 Git 仓库。

TIP

--local选项仅在 SDK ≥ 0.8.0 版本中可用。

本地登录适用于多人共用服务器、多项目隔离等场景——每个项目可以使用不同的账号，互不影响。

bash

swanlab logout

如果需要退出本地登录的账号：

bash

swanlab logout --local