Installation

This page helps you install Memo, check that it works, and know where it keeps its files. When you are done, memo --help lists Memo's commands and you can import your first folder of notes. You need Node.js; everything else on this page is needed only for the sources that use it.

What it needsCopy Anchor Link

• Node.js 22.16 or newer (version 22.16+ or 24+), with npm. Node.js runs Memo, and npm installs it. If you do not have them, ask your agent to help you install them, or get them from nodejs.org.
• Notes and documents: nothing more. PDF and Word (.docx) files need two optional readers, see files Memo can read.
• Messages: tg for Telegram or max for MAX. They save your chats in the local store, and Memo reads them from there. Memo does not log in to a messenger itself.
• Search by meaning: a small search model that runs on your computer. tg or max downloads it once: tg models text download e5-small, or max models text download e5-small. Without it, Memo searches by words.
• Mail: Himalaya, a mail program that Memo uses to read your mailbox (mail).
• Importing on a timer (memo auto): Linux. On macOS and Windows, run memo import yourself or from your own scheduler (keeping Memo up to date).

InstallCopy Anchor Link

The easiest way: ask your agent.

Install Memo with npm install -g @wirecat/cli-memo.
Check Node.js and npm first and help me set them up if needed.
Then run memo --help and tell me if it works.

Or install it yourself. Open a terminal and run:

npm install -g @wirecat/cli-memo
memo --help

On Windows, open PowerShell and run:

npm.cmd install -g @wirecat/cli-memo
memo --help

memo --help should list commands such as notes, search and tags. If the terminal says the command is not found, close it, open a new one and try again.

Memo has no login step. Next, add a folder of notes or connect a mail account.

Where the files areCopy Anchor Link

~ means your home folder. Your note files and your mailbox stay where they are; the local store holds a copy of their text.

Update and removeCopy Anchor Link

npm install -g @wirecat/cli-memo     # update to the latest version
npm uninstall -g @wirecat/cli-memo   # remove the memo command

If you turned on the timer, run memo auto off before you remove Memo. Removing Memo keeps the local store and the settings, because tg and max use the same store.

DevelopmentCopy Anchor Link

To work on Memo itself, clone the repository and run:

pnpm install
pnpm lint && pnpm typecheck && pnpm test