A Python CLI for importing and exporting Google Keep notes to markdown directories.
KeIO stores sync metadata in an HTML comment footer at the bottom of each exported markdown file, enabling conflict detection and incremental syncing.
Fun fact: KeIO stands for "Keep I/O" 😊
pip install keioOr with uv:
uv tool install keioTo use the gkeepapi backend (see Authentication below):
pip install "keio[gkeepapi]"KeIO supports two authentication backends. You must pick one; they cannot be mixed.
Warning
The official Google Keep API is only available to Google Workspace
Enterprise users. It will not work with free @gmail.com accounts or non-Enterprise
Workspace plans.
This backend uses the official REST API with a standard OAuth 2.0 Desktop App flow.
- Go to Google Cloud Console.
- Create or select a Google Cloud project.
- Search for "Google Keep API", open it, and click Enable.
- Search for "Google Auth platform" and open it.
- If no app exists yet, use the setup wizard to create one.
- Open Clients and create a Desktop app OAuth client (or download JSON from an existing one).
- Run setup and login:
keio auth setup --method enterprise --credentials /path/to/credentials.json
keio auth loginReferences:
Warning
This backend uses the unofficial gkeepapi library, which reverse-engineers the mobile Google Keep protocol. It can break without notice if Google changes their internal API. Attachment download support is limited.
This backend works with any Google account, including free @gmail.com. Setup requires
obtaining a master token via a Docker one-liner.
Step 1 -- Get an OAuth token cookie:
- Open https://accounts.google.com/EmbeddedSetup in your browser.
- Log in with your Google account and click "I agree". (The page may show a loading screen indefinitely after this; that is expected.)
- Open browser developer tools -> Application -> Cookies.
- Copy the value of the
oauth_tokencookie.
Step 2 -- Get a master token (via Docker):
docker run --rm -it python:3 sh -c '
pip install -q gpsoauth && python3 -c "
import gpsoauth,secrets,json
e=input(\"Email: \")
t=input(\"OAuth token: \")
a=secrets.token_hex(8)
r=gpsoauth.exchange_token(e,t,a)
print(json.dumps({\"email\":e,\"master_token\":r[\"Token\"]}))"'Step 3 -- Pass the JSON to keio:
You can pass the JSON output directly:
keio auth setup --method gkeepapi --credentials '{"email":"...","master_token":"..."}'Or save it to a file first:
keio auth setup --method gkeepapi --credentials /path/to/token.jsonThen verify:
keio auth loginReferences:
keio auth status # Show current method and login state
keio auth logout # Remove cached tokensExport your Google Keep notes to a local directory:
keio export /path/to/notes- Downloads note text, checklists, and attachments.
- Skips locally modified files unless
--forceis used. - Use
--dry-runto preview without writing.
Import markdown files back to Google Keep:
keio import /path/to/notes- Supports note text and checklist content.
- Uses footer metadata to detect stale local files and avoid conflicts.
- Skips notes whose remote version is newer unless
--forceis used. - Use
--dry-runto preview without creating or replacing notes.
Important
Neither the official Keep API nor gkeepapi supports uploading attachments programmatically. Export can download images, but import cannot upload them.
The --images flag provides a semi-automated workaround:
keio import /path/to/notes --imagesFor each note that has local attachments, --images will:
- Create or update the note text in Google Keep as usual.
- Open the note in your browser and the attachment folder in your file explorer.
- Poll the note for up to 5 minutes, waiting for you to drag-and-drop the images into Keep manually.
- Press Enter at any time to skip a note and move on.
This makes it practical to re-attach images in bulk without hunting for each note by hand.
| Flag | Applies to | Description |
|---|---|---|
--dry-run |
export, import | Preview changes without writing |
--force |
export, import | Ignore conflict checks and overwrite |
--credentials PATH |
export, import | Override OAuth credentials file |
--images |
import | Assist with manual image upload (see above) |
git clone https://github.com/soldni/keio.git
cd keio
uv sync --extra dev
uv run pytestApache-2.0