getnote-auth

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

getnote-auth Skill

getnote-auth Skill

Log in, log out, and check authentication status.
用于实现登录、登出以及身份验证状态检查功能。

Commands

命令

Log in

登录

getnote auth login [--api-key <key>] [--client-id <id>]
ModeCommandDescription
OAuth (recommended)
getnote auth login
Opens browser to authorize; saves credentials automatically
API Key
getnote auth login --api-key <key>
Saves key directly, no browser needed
bash
undefined
getnote auth login [--api-key <key>] [--client-id <id>]
模式命令说明
OAuth(推荐)
getnote auth login
打开浏览器进行授权,自动保存凭证
API Key
getnote auth login --api-key <key>
直接保存密钥,无需打开浏览器
bash
undefined

OAuth flow (opens browser)

OAuth流程(打开浏览器)

getnote auth login
getnote auth login

API key directly

直接使用API密钥

getnote auth login --api-key gk_live_xxx
getnote auth login --api-key gk_live_xxx

API key + Client ID

API密钥 + Client ID

getnote auth login --api-key gk_live_xxx --client-id cli_xxx

Get your API key at: https://www.biji.com/settings/developer (keys start with `gk_live_`)

---
getnote auth login --api-key gk_live_xxx --client-id cli_xxx

你可以在以下地址获取你的API密钥:https://www.biji.com/settings/developer(密钥以`gk_live_`开头)

---

Check status

检查状态

getnote auth status
Shows whether authenticated and which API key is active.
bash
getnote auth status

getnote auth status
展示当前是否已通过身份验证,以及正在生效的API密钥。
bash
getnote auth status

Log out

登出

getnote auth logout
Removes saved credentials from
~/.getnote/config.json
.
bash
getnote auth logout

getnote auth logout
~/.getnote/config.json
中移除已保存的凭证。
bash
getnote auth logout

Agent Usage Notes

Agent使用注意事项

  • Always run
    getnote auth status
    first to verify authentication before other commands.
  • If not authenticated, prompt the user to run
    getnote auth login
    .
  • --api-key
    on any command is a temporary per-invocation override and does not save credentials.
  • Credentials saved at
    ~/.getnote/config.json
    ; env vars
    GETNOTE_API_KEY
    /
    GETNOTE_CLIENT_ID
    take higher priority.
  • 在运行其他命令前,请务必先执行
    getnote auth status
    验证身份验证状态。
  • 如果未通过验证,请提示用户执行
    getnote auth login
    命令。
  • 任意命令中携带的
    --api-key
    参数仅单次调用临时生效,不会保存凭证。
  • 凭证保存在
    ~/.getnote/config.json
    中;环境变量
    GETNOTE_API_KEY
    /
    GETNOTE_CLIENT_ID
    的优先级更高。