Skip to content

docs: add Arch Linux nmem CLI install guidance#269

Merged
wey-gu merged 2 commits into
mainfrom
docs/arch-nmem-cli-aur
Jun 4, 2026
Merged

docs: add Arch Linux nmem CLI install guidance#269
wey-gu merged 2 commits into
mainfrom
docs/arch-nmem-cli-aur

Conversation

@wey-gu

@wey-gu wey-gu commented Jun 4, 2026

Copy link
Copy Markdown
Member

Summary

  • add Arch Linux AUR install guidance for nmem-cli
  • update connector README prerequisites and shared skill fallback guidance
  • credit @czyt for publishing the AUR package and reporting the Arch install issue

Closes #268

Validation

  • git diff --check
  • node nowledge-mem-codex-plugin/scripts/validate-plugin.mjs

Summary by CodeRabbit

  • Documentation
    • Expanded installation instructions across the project to offer additional ways to install the nmem CLI (including Arch AUR options alongside existing pip and in-app install guidance).
    • Clarified and broadened troubleshooting guidance where nmem is not on the system PATH, adding platform-specific install suggestions to help users get the CLI working.

Note

Low Risk
Markdown-only documentation updates with no runtime, auth, or integration logic changes.

Overview
Documentation-only change: Arch Linux users can install nmem-cli via the AUR (yay / paru) alongside existing desktop-app and pip paths.

The root README Requirements section and integration README prerequisites (Bub, Claude Code, Copilot CLI, Codex, Droid, Hermes, npx-skills, OpenCode, Pi, Proma, etc.) now mention AUR install where relevant. Troubleshooting blocks in shared SKILL files (Claude/Copilot skills, npx status, OpenClaw setup guide, Pi status) were updated so agents suggest AUR when nmem is missing from PATH. Codex and npx-skills add a dedicated AUR option section with link to https://aur.archlinux.org/packages/nmem-cli.

Reviewed by Cursor Bugbot for commit 8a45452. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-authored-by: 虫子樱桃 <19337206+czyt@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fe97e7e1-0d65-4336-96f5-24839bcb0874

📥 Commits

Reviewing files that changed from the base of the PR and between 8a45452 and 4f426ba.

📒 Files selected for processing (3)
  • nowledge-mem-opencode-plugin/README.md
  • nowledge-mem-pi-package/README.md
  • nowledge-mem-proma-plugin/README.md
✅ Files skipped from review due to trivial changes (1)
  • nowledge-mem-proma-plugin/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • nowledge-mem-pi-package/README.md

📝 Walkthrough

Walkthrough

This PR adds Arch Linux AUR package manager installation options (yay -S nmem-cli / paru -S nmem-cli) for the nmem-cli tool across README prerequisites and SKILL troubleshooting documentation, and updates a submodule commit reference.

Changes

Arch Linux nmem-cli Installation Guidance

Layer / File(s) Summary
Primary README installation documentation
README.md, nowledge-mem-hermes/README.md, nowledge-mem-bub-plugin/README.md, nowledge-mem-claude-code-plugin/README.md, nowledge-mem-codex-plugin/README.md, nowledge-mem-copilot-cli-plugin/README.md, nowledge-mem-droid-plugin/README.md, nowledge-mem-npx-skills/README.md, nowledge-mem-opencode-plugin/README.md, nowledge-mem-pi-package/README.md, nowledge-mem-proma-plugin/README.md
Root and plugin-level README prerequisites and troubleshooting sections now document Arch Linux AUR installation via yay or paru as an alternative to pip install nmem-cli, and include verification steps like nmem --version / nmem status.
Skill troubleshooting documentation
nowledge-mem-claude-code-plugin/skills/*/SKILL.md, nowledge-mem-copilot-cli-plugin/skills/*/SKILL.md, nowledge-mem-npx-skills/skills/status/SKILL.md, nowledge-mem-openclaw-plugin/SKILL.md, nowledge-mem-pi-package/skills/status/SKILL.md
Skill documentation troubleshooting sections expanded with Arch Linux package manager commands to resolve nmem not-in-PATH errors, extending existing pip/pipx/desktop-app guidance with yay/paru alternatives.
Submodule reference
nowledge-mem-gemini-cli
Git submodule commit reference updated to a new hash.

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly Related PRs

  • nowledge-co/community#150: Both PRs touch the Codex plugin’s README/setup documentation that this PR extends with Arch yay/paru install options.
  • nowledge-co/community#36: Earlier README and SKILL troubleshooting edits for Claude Code plugin skills related to CLI installation; changes in this PR build on that structure.
  • nowledge-co/community#44: Updates to nowledge-mem-npx-skills/README.md that this PR further extends by adding Arch AUR installation instructions.

Poem

🐰 I hopped through docs both near and far,
Placed yay and paru beside pip like a star,
Now Arch users can install with a cheer,
The CLI's in reach, the path is clear — hooray, my dear!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning One submodule reference update (nowledge-mem-gemini-cli) appears unrelated to Arch Linux nmem-cli installation guidance and may be out of scope. Review whether the nowledge-mem-gemini-cli submodule update is necessary for this PR or should be submitted separately to maintain PR focus.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding Arch Linux nmem CLI installation guidance across multiple documentation files.
Linked Issues check ✅ Passed The pull request fulfills issue #268 by adding AUR package installation instructions (yay/paru) for nmem-cli across README and SKILL documentation files.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/arch-nmem-cli-aur

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 commented Jun 4, 2026

Copy link
Copy Markdown
Member Author

bugbot run

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit 8a45452. Configure here.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation update to help Arch Linux users install nmem-cli reliably by adding AUR-based installation guidance across the root README, multiple integration READMEs, and skill troubleshooting sections where “nmem not found in PATH” is addressed.

Changes:

  • Add Arch Linux AUR install option (yay / paru) for nmem-cli alongside existing desktop-app and pip / pipx / uvx guidance.
  • Update troubleshooting guidance in shared SKILL files to mention AUR as an additional fallback when nmem is missing from PATH.
  • Add a dedicated “Arch Linux AUR” install option section in select READMEs (e.g., npx-skills) with an explicit AUR link.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated no comments.

Show a summary per file
File Description
README.md Adds AUR install guidance for nmem-cli in the root Requirements section.
nowledge-mem-proma-plugin/README.md Updates prerequisites to include Arch AUR install option.
nowledge-mem-pi-package/skills/status/SKILL.md Extends troubleshooting step to include Arch AUR install commands.
nowledge-mem-pi-package/README.md Adds Arch AUR comment line in the prerequisite install snippet.
nowledge-mem-opencode-plugin/README.md Updates prerequisites to include Arch AUR install option.
nowledge-mem-openclaw-plugin/SKILL.md Adds Arch AUR as an alternative in the “verify nmem” failure guidance.
nowledge-mem-npx-skills/skills/status/SKILL.md Adds Arch AUR as another install option in troubleshooting.
nowledge-mem-npx-skills/README.md Adds a dedicated “Option 3: Arch Linux AUR” section and AUR link.
nowledge-mem-hermes/README.md Updates prerequisites to include Arch AUR install option.
nowledge-mem-droid-plugin/README.md Adds Arch AUR as an additional install option in the requirements snippet.
nowledge-mem-copilot-cli-plugin/skills/search-memory/SKILL.md Updates troubleshooting guidance to include Arch AUR commands.
nowledge-mem-copilot-cli-plugin/skills/save-thread/SKILL.md Updates troubleshooting guidance to include Arch AUR commands.
nowledge-mem-copilot-cli-plugin/skills/read-working-memory/SKILL.md Updates troubleshooting guidance to include Arch AUR commands.
nowledge-mem-copilot-cli-plugin/skills/distill-memory/SKILL.md Updates troubleshooting guidance to include Arch AUR commands.
nowledge-mem-copilot-cli-plugin/README.md Adds Arch AUR comment line in the prerequisite install snippet.
nowledge-mem-codex-plugin/README.md Adds Arch AUR guidance alongside existing pip/uvx install paths.
nowledge-mem-claude-code-plugin/skills/search-memory/SKILL.md Updates troubleshooting guidance to include Arch AUR commands.
nowledge-mem-claude-code-plugin/skills/save-thread/SKILL.md Updates troubleshooting guidance to include Arch AUR commands.
nowledge-mem-claude-code-plugin/skills/read-working-memory/SKILL.md Updates troubleshooting guidance to include Arch AUR commands.
nowledge-mem-claude-code-plugin/skills/distill-memory/SKILL.md Updates troubleshooting guidance to include Arch AUR commands.
nowledge-mem-claude-code-plugin/README.md Adds Arch AUR comment line in the prerequisite install snippet.
nowledge-mem-bub-plugin/README.md Adds Arch AUR comment line in the prerequisite install snippet.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@nowledge-mem-opencode-plugin/README.md`:
- Line 17: Update the Troubleshooting section entry that currently only suggests
the `pip install nmem-cli` command to mirror the prerequisites wording: keep the
existing `pip install nmem-cli` suggestion and add the Arch AUR alternatives
`yay -S nmem-cli` / `paru -S nmem-cli` so the Troubleshooting "Install CLI"
guidance matches the earlier Prerequisites wording and resolves issue `#268`.

In `@nowledge-mem-pi-package/README.md`:
- Line 24: The Troubleshooting section is missing the Arch AUR install command;
update the Troubleshooting paragraph (the "Troubleshooting" heading) to mirror
the new Arch path by adding the same Arch install instruction shown earlier
("Arch Linux: yay -S nmem-cli  # or: paru -S nmem-cli") so Arch users see the
identical fix path for nmem-cli in both the Prerequisites and Troubleshooting
sections.

In `@nowledge-mem-proma-plugin/README.md`:
- Line 12: Update the "nmem CLI not found" troubleshooting block so it matches
the new prerequisite guidance: when suggesting installation options add the Arch
AUR commands alongside the existing options, i.e., include "yay -S nmem-cli /
paru -S nmem-cli" in the same sentence as the bundled Nowledge Mem desktop app
and `pip install nmem-cli` suggestions; locate the block by the literal
header/string "nmem CLI not found" and update that paragraph accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 692154fd-0ada-4ee6-9cc2-34d0ec51e855

📥 Commits

Reviewing files that changed from the base of the PR and between 94cf1c5 and 8a45452.

📒 Files selected for processing (23)
  • README.md
  • nowledge-mem-bub-plugin/README.md
  • nowledge-mem-claude-code-plugin/README.md
  • nowledge-mem-claude-code-plugin/skills/distill-memory/SKILL.md
  • nowledge-mem-claude-code-plugin/skills/read-working-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-plugin/README.md
  • nowledge-mem-copilot-cli-plugin/README.md
  • nowledge-mem-copilot-cli-plugin/skills/distill-memory/SKILL.md
  • nowledge-mem-copilot-cli-plugin/skills/read-working-memory/SKILL.md
  • nowledge-mem-copilot-cli-plugin/skills/save-thread/SKILL.md
  • nowledge-mem-copilot-cli-plugin/skills/search-memory/SKILL.md
  • nowledge-mem-droid-plugin/README.md
  • nowledge-mem-gemini-cli
  • nowledge-mem-hermes/README.md
  • nowledge-mem-npx-skills/README.md
  • nowledge-mem-npx-skills/skills/status/SKILL.md
  • nowledge-mem-openclaw-plugin/SKILL.md
  • nowledge-mem-opencode-plugin/README.md
  • nowledge-mem-pi-package/README.md
  • nowledge-mem-pi-package/skills/status/SKILL.md
  • nowledge-mem-proma-plugin/README.md

Comment thread nowledge-mem-opencode-plugin/README.md
Comment thread nowledge-mem-pi-package/README.md
Comment thread nowledge-mem-proma-plugin/README.md
Co-authored-by: 虫子樱桃 <19337206+czyt@users.noreply.github.com>
@wey-gu wey-gu merged commit c188add into main Jun 4, 2026
1 check passed
@wey-gu wey-gu deleted the docs/arch-nmem-cli-aur branch June 4, 2026 04:54
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.

arch linux安装nmem-cli失败

2 participants