Skip to content

Nmem-cli package references#41

Merged
wey-gu merged 1 commit intomainfrom
cursor/nmem-cli-package-references-e0f5
Jan 14, 2026
Merged

Nmem-cli package references#41
wey-gu merged 1 commit intomainfrom
cursor/nmem-cli-package-references-e0f5

Conversation

@wey-gu
Copy link
Copy Markdown
Member

@wey-gu wey-gu commented Jan 14, 2026

Update documentation and scripts to consistently use nmem-cli as the PyPI package name for installation.

The nmem command-line tool is installed via the nmem-cli package, and this PR ensures all installation instructions and uvx commands correctly reflect this distinction.


Open in Cursor Open in Web


Note

Standardizes installation instructions and CLI usage to reference the nmem-cli PyPI package and uvx --from nmem-cli nmem invocation across documentation and helper scripts.

  • Updates examples/AGENTS.md, plugin README.md, skill docs, and Codex prompts README to replace pip install nmem with pip install nmem-cli
  • Replaces uvx nmem ... with uvx --from nmem-cli nmem ..., including refresh and version examples
  • Aligns troubleshooting notes and echoes in nowledge-mem-codex-prompts/install.sh to the new package and uvx syntax

Written by Cursor Bugbot for commit 9373243. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Documentation

    • Updated all installation and usage instructions across documentation and skill guides to reflect the new package naming and revised CLI invocation patterns.
  • Chores

    • Updated installation scripts and command examples with the new package naming conventions and CLI command syntax.

✏️ Tip: You can customize this high-level summary in your review settings.

Replace `pip install nmem`/`pipx install nmem` with `nmem-cli`, and update uvx examples to run `nmem` from `nmem-cli`.

Co-authored-by: weyl.gu <weyl.gu@gmail.com>
@cursor
Copy link
Copy Markdown

cursor Bot commented Jan 14, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 14, 2026

📝 Walkthrough

Walkthrough

This pull request updates documentation and installation instructions across multiple files to reflect a CLI invocation pattern change from uvx nmem to uvx --from nmem-cli nmem and renames the pip package from nmem to nmem-cli. All changes are documentation-focused with no functional code modifications.

Changes

Cohort / File(s) Summary
Documentation - CLI Command Pattern Updates
examples/AGENTS.md, nowledge-mem-claude-code-plugin/README.md, nowledge-mem-claude-code-plugin/skills/distill-memory/SKILL.md, nowledge-mem-claude-code-plugin/skills/save-thread/SKILL.md, nowledge-mem-claude-code-plugin/skills/search-memory/SKILL.md, nowledge-mem-codex-prompts/README.md
Updates uvx invocation syntax from uvx nmem --version to uvx --from nmem-cli nmem --version and pip package name from pip install nmem to pip install nmem-cli across setup, verification, and troubleshooting sections.
Installation Script Updates
nowledge-mem-codex-prompts/install.sh
Updates user-facing messages and command examples in the installation script to use nmem-cli package name and uvx --from nmem-cli nmem invocation pattern across interactive and non-interactive prompts.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Poem

🐰 Oh, what joy when docs align with names so true,
From nmem to nmem-cli in every view!
Through --from prefixes, the CLI now gleams,
A hop and a skip through documentation dreams! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Nmem-cli package references' directly and accurately summarizes the main change: updating documentation and scripts to reference the nmem-cli package name throughout the codebase.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings


📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 407637f and 9373243.

📒 Files selected for processing (7)
  • examples/AGENTS.md
  • nowledge-mem-claude-code-plugin/README.md
  • nowledge-mem-claude-code-plugin/skills/distill-memory/SKILL.md
  • nowledge-mem-claude-code-plugin/skills/save-thread/SKILL.md
  • nowledge-mem-claude-code-plugin/skills/search-memory/SKILL.md
  • nowledge-mem-codex-prompts/README.md
  • nowledge-mem-codex-prompts/install.sh
🧰 Additional context used
📓 Path-based instructions (1)
examples/**/AGENTS.md

📄 CodeRabbit inference engine (examples/AGENTS.md)

Add Nowledge Mem Integration section to project's AGENTS.md file to enable AI agents to autonomously manage knowledge

Files:

  • examples/AGENTS.md
🧠 Learnings (4)
📓 Common learnings
Learnt from: CR
Repo: nowledge-co/community PR: 0
File: examples/AGENTS.md:0-0
Timestamp: 2026-01-08T10:01:11.102Z
Learning: Use `uvx nmem` (recommended) or `pip install nmem` for installation; on Windows/Linux with Nowledge Mem Desktop app, nmem is bundled; on macOS or remote servers, use uvx or install manually
📚 Learning: 2026-01-08T10:01:11.102Z
Learnt from: CR
Repo: nowledge-co/community PR: 0
File: examples/AGENTS.md:0-0
Timestamp: 2026-01-08T10:01:11.102Z
Learning: Use `uvx nmem` (recommended) or `pip install nmem` for installation; on Windows/Linux with Nowledge Mem Desktop app, nmem is bundled; on macOS or remote servers, use uvx or install manually

Applied to files:

  • nowledge-mem-codex-prompts/README.md
  • nowledge-mem-codex-prompts/install.sh
  • nowledge-mem-claude-code-plugin/README.md
  • examples/AGENTS.md
  • nowledge-mem-claude-code-plugin/skills/distill-memory/SKILL.md
  • nowledge-mem-claude-code-plugin/skills/save-thread/SKILL.md
  • nowledge-mem-claude-code-plugin/skills/search-memory/SKILL.md
📚 Learning: 2026-01-08T10:01:11.102Z
Learnt from: CR
Repo: nowledge-co/community PR: 0
File: examples/AGENTS.md:0-0
Timestamp: 2026-01-08T10:01:11.102Z
Learning: Applies to examples/**/AGENTS.md : Add Nowledge Mem Integration section to project's `AGENTS.md` file to enable AI agents to autonomously manage knowledge

Applied to files:

  • examples/AGENTS.md
📚 Learning: 2026-01-08T10:01:11.102Z
Learnt from: CR
Repo: nowledge-co/community PR: 0
File: examples/AGENTS.md:0-0
Timestamp: 2026-01-08T10:01:11.102Z
Learning: Applies to examples/.claude/config.json : Add SessionEnd hook to `.claude/config.json` that runs `nmem t save --from claude-code` to automatically save sessions on exit

Applied to files:

  • nowledge-mem-claude-code-plugin/skills/save-thread/SKILL.md
🪛 markdownlint-cli2 (0.18.1)
nowledge-mem-claude-code-plugin/README.md

77-77: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Cursor Bugbot
🔇 Additional comments (13)
nowledge-mem-claude-code-plugin/skills/distill-memory/SKILL.md (1)

79-84: LGTM! Documentation correctly updated to use nmem-cli package.

The troubleshooting section now correctly references the nmem-cli PyPI package name and uses the proper uvx --from nmem-cli nmem invocation pattern to distinguish between the package name and the command it provides.

nowledge-mem-claude-code-plugin/README.md (1)

68-92: LGTM! Installation instructions consistently updated.

All installation methods (uvx, pip, pipx) now correctly reference the nmem-cli package, and the cache refresh command properly includes the --from nmem-cli flag. The documentation clearly distinguishes between the PyPI package name (nmem-cli) and the command it provides (nmem).

examples/AGENTS.md (1)

117-120: LGTM! Setup instructions correctly updated.

The setup section now properly references nmem-cli as the package name and uses uvx --from nmem-cli nmem for the uvx invocation pattern.

Note: The retrieved learning states "Use uvx nmem (recommended) or pip install nmem" which is now outdated by these changes. The learning should be updated to reflect the new nmem-cli package name and uvx --from nmem-cli nmem pattern.

Based on learnings, the installation pattern has changed from the previously documented approach.

nowledge-mem-claude-code-plugin/skills/save-thread/SKILL.md (1)

68-73: LGTM! Troubleshooting commands properly updated.

The troubleshooting section correctly demonstrates the full command including both the uvx --from nmem-cli flag and the nmem subcommand's --from claude-code flag, making the distinction between the two clear.

nowledge-mem-claude-code-plugin/skills/search-memory/SKILL.md (1)

88-93: LGTM! Documentation updated consistently with other files.

The troubleshooting section now correctly uses nmem-cli as the package name and the uvx --from nmem-cli nmem invocation pattern, maintaining consistency across all SKILL.md files.

nowledge-mem-codex-prompts/install.sh (3)

125-133: LGTM! Installation options updated correctly.

The updated commands correctly use the nmem-cli package name:

  • uvx --from nmem-cli nmem syntax is correct when the package name differs from the command name
  • pip install nmem-cli and pipx install nmem-cli use the proper PyPI package name

146-159: LGTM! Non-interactive and interactive mode instructions are consistent.

Both the interactive prompt (line 146) and non-interactive fallback (lines 152, 159) correctly show the updated uvx --from nmem-cli nmem pattern.


163-169: LGTM! Fallback installation options are consistent with the earlier block.

The pip and pipx installation instructions in the "uv not available" branch match the updated package name pattern established earlier.

nowledge-mem-codex-prompts/README.md (5)

31-31: LGTM! Prerequisites section updated correctly.

The inline instructions now reference the correct package name for both uvx and pip installation methods.


45-51: LGTM! uvx examples are correct.

The --from nmem-cli nmem syntax correctly specifies the package source while invoking the nmem command. The cache refresh command on line 51 also correctly includes --refresh --from nmem-cli nmem.


58-61: LGTM! Traditional installation commands updated.

Both pip and pipx installation commands correctly reference nmem-cli.


69-69: LGTM! Verification example is consistent.

The uvx verification command matches the pattern used throughout the document.


80-80: LGTM! Troubleshooting guidance is consistent.

The troubleshooting entry for "Command not found: nmem" now correctly suggests both the uvx pattern and pip installation with the nmem-cli package name.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@wey-gu wey-gu marked this pull request as ready for review January 14, 2026 04:11
@wey-gu wey-gu merged commit a7f185f into main Jan 14, 2026
2 checks passed
@wey-gu wey-gu deleted the cursor/nmem-cli-package-references-e0f5 branch January 14, 2026 05:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants