@xaju/kami
v0.1.2
Published
Local-first notes CLI with a terminal UI and GitHub Markdown sync.
Downloads
472
Readme
Kami
Kami is a local-first notes app for your terminal, with simple GitHub sync.
Install
npm install -g @xaju/kamiCheck that it works:
kami helpFirst Note
Create a note:
kami addList your notes:
kami listKami shows each note with a short ID:
45438ad0 meeting ideas
efdfdebb books to readUse that ID to read or edit a note:
kami get 45438ad0
kami edit 45438ad0Sync With GitHub
Sign in:
kami loginFollow the browser instructions, then sync:
kami syncBy default, Kami syncs to a private GitHub repo named kami, inside a notes/ folder.
Check your sync setup:
kami github-statusDaily Workflow
kami add
kami list
kami search idea
kami edit <note-id>
kami syncCommands
kami helpShow all commands.
kami loginSign in with GitHub.
kami whoamiShow the signed-in GitHub user.
kami addCreate a note in the terminal editor.
kami import <file.md>Move an existing Markdown file into Kami.
kami listList local notes with short IDs.
kami get <note-id>Print one note.
kami edit <note-id>Edit one note.
kami search <query>Search local notes.
kami delete <note-id>Delete a note locally and from GitHub on the next sync.
kami delete <note-id> --local-onlyRemove a note from this device only.
kami syncSync notes with GitHub.
kami logoutSign out locally.
kami github-statusShow GitHub sync status.
Uninstall
npm uninstall -g @xaju/kamiIf Something Goes Wrong
Use @xaju/kami, not the old package name.
If install fails, wait a minute and try again:
npm cache verify
npm install -g @xaju/kamiIf sync says you are not logged in:
kami loginIf GitHub does not show your notes:
kami github-status
kami sync