Getnote Auth
Configure and verify Get笔记 (GetNote) CLI authentication before agents run note sync or API commands.
Overview
getnote-auth is an agent skill for the Build phase that manages GetNote CLI login, logout, and authentication status via OAuth or API key.
Install
npx skills add https://github.com/iswalle/getnote-cli --skill getnote-authWhat is this skill?
- OAuth browser login (recommended) or direct API key via `getnote auth login --api-key`
- `getnote auth status` to confirm active key before any other getnote commands
- `getnote auth logout` clears `~/.getnote/config.json` credentials
- Per-invocation `--api-key` override without persisting to disk
- Env vars `GETNOTE_API_KEY` / `GETNOTE_CLIENT_ID` override saved config priority
- API keys prefixed with `gk_live_`
- Config path `~/.getnote/config.json`
- Skill version 0.4.0 documented in frontmatter
Adoption & trust: 633 installs on skills.sh; 127 GitHub stars; 3/3 security scanners passed (skills.sh audits).
What problem does it solve?
Your agent keeps calling GetNote CLI commands without knowing whether OAuth or API key credentials are actually saved.
Who is it for?
Anyone wiring GetNote into Claude Code or Cursor workflows who wants explicit pre-flight auth checks.
Skip if: Users who only need note editing features without the CLI, or teams that forbid local credential files without reviewing security audits.
When should I use this skill?
Before any other GetNote CLI command when authentication may be missing or stale.
What do I get? / Deliverables
Credentials are verified or established in `~/.getnote/config.json` (or env overrides) so subsequent GetNote CLI skills can run without silent auth failures.
- Verified auth session or explicit user prompt to login
- Cleared credentials after logout
Recommended Skills
Journey fit
Auth setup is part of wiring third-party tooling into your stack during Build, before dependent CLI skills can run. Integrations is the right shelf because the skill only manages credentials and session state for the GetNote CLI.
How it compares
CLI credential helper only—not a notes MCP server or full GetNote product skill pack.
Common Questions / FAQ
Who is getnote-auth for?
Solo builders and agents using the Get笔记 CLI who need a documented login, status, and logout flow before other commands.
When should I use getnote-auth?
At the start of any Build integration session before sync, export, or other getnote subcommands, especially when status is unknown.
Is getnote-auth safe to install?
It stores API keys locally and may open OAuth in a browser; review the Security Audits panel on this page and prefer env vars in shared CI environments.
SKILL.md
READMESKILL.md - Getnote Auth
# getnote-auth Skill Log in, log out, and check authentication status. ## Commands ### Log in ``` getnote auth login [--api-key <key>] ``` | Mode | Command | Description | |------|---------|-------------| | 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 # OAuth flow (opens browser) getnote auth login # API key directly getnote auth login --api-key gk_live_xxx ``` Get your API key at: https://www.biji.com/settings/developer (keys start with `gk_live_`) --- ### Check status ``` getnote auth status ``` Shows whether authenticated and which API key is active. ```bash getnote auth status ``` --- ### Log out ``` getnote auth logout ``` Removes saved credentials from `~/.getnote/config.json`. ```bash getnote auth logout ``` --- ## Agent Usage Notes - 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.