rig-wiki

rig

中文文档

What's in this package

• Multi-repo workspace tooling (the original purpose): rig init / add / dev / install / build / deploy / publish / sync / tag. See Get started below.
• rig wiki * — Karpathy-style LLM Wiki ops (scan / fetch / ingest / query / lint), with a launchd daemon for periodic runs. Backed by Claude Code as the executor. macOS only, Node ≥ 22. See RIG_WIKI_SKILL.md and doc/architecture/wiki.md.
• rig crew * — file-backed, Leader-first multi-agent coordination over an Obsidian vault. Supports project owners, a human dashboard, inbox, and mixed executors such as Claude Code and Codex. See RIG_CREW_SKILL.md.
• Bundled Claude Code skill — rig-wiki, registered as a Claude Code plugin via .claude-plugin/plugin.json. rig-crew is Vault-level guidance rather than a project-local plugin copy. See the skill index: skills.md.

Installing bundled skills (three paths)

Pick one — they all end with Claude Code seeing bundled skills under ~/.claude/skills/.

1. npm i -g rigjs — the package's postinstall script symlinks bundled skills into ~/.claude/skills/ automatically. No further action.
2. npm i -g rigjs --ignore-scripts (security-conscious users) — postinstall is skipped, so finish with rig wiki install-skill.
3. Claude Code plugin marketplace — once you (or anyone) host a marketplace.json pointing at { "source": "npm", "package": "rigjs" }, users install via /plugin install rig-wiki@<marketplace> — Claude Code handles everything; postinstall does not run.

Opt-out for path 1: RIG_NO_AUTO_SKILL=1 npm i -g rigjs. To remove: rig wiki uninstall-skill.

Get started

0.Prerequisites

Install yarn

yarn global add rigjs

Rigjs use yarn workspaces to achieve module-hoisting. About yarn workspaces.

NodeJS version >= 14

Use n to update NodeJS.

yarn global add n
#upgrade to lts
sudo n lts 
#or specify the version.
sudo n 14.19.1

1.Initialize rigjs configuration。

#in your project's root path（same level with package.json）：
rig init

package.rig.json5 will be added in root path.

2.Use rigjs to install existing repos.

2.1 Method-one：rig add

rig add [your-git-ssh-url] [tag]

example:

rig add [email protected]:FlashHand/rig-demo-1.git 0.0.1

import or require the module.

const {hello} = require('rig-demo-1');
hello();

2.2 Method-two：change package.rig.json5

{
  dependencies: {
    'rig-demo-1': {
      source: '[email protected]:FlashHand/rig-demo-1.git',
      version: '0.0.1',
    }
  }
}

then

yarn install

3.Use rigjs to develop an existing repo.

3.1 Method-one：rig dev

rig dev [package's name|git-ssh-url]

When package is already in package.rig.json5:

rig dev rig-demo-1

When package is not in package.rig.json5:

rig dev [email protected]:FlashHand/rig-demo-1.git

rig-demo-1 will be installed in rig_dev directory.And a symlink of the module will be created in node_modules.

3.1 Method-two：change package.rig.json5

{
  dependencies: {
    'rig-demo-1': {
      source: '[email protected]:FlashHand/rig-demo-1.git',
      version: '0.0.1',
      dev: true //false by default
    }
  }
}

then

yarn install

4.Create and develop a new rigjs module。

4.1 Create a git repo。

get git-ssh url: [email protected]:FlashHand/rig-demo-1.git

4.2 Start developing your modules in rigjs dependencies

rig dev [email protected]:FlashHand/rig-demo-1.git

4.3 Initialize your module

cd your_project_path
cd rig_dev/rig-demo-1
yarn init 
echo "module.export={hello:()=>{console.log('hello')}}" > index.js

4.4 Use rigjs modules in your main project。

const {hello} = require('rig-demo-1');
hello();

4.5 Use rigjs module in production。

publish tag

cd rig_dev/rig-demo-1
git add .
git commit -m 'demo for rig'
git tag 0.0.1
git push origin your_branch --tag

Modify package.rig.json5

• Change the module's version
• Set dev to false.Don't use dev mode in production and should specify the version you need.

{
  dependencies: {
    'rig-demo-1': {
      source: '[email protected]:FlashHand/rig-demo-1.git',
      version: '0.0.1',
//      dev:true//Don't use dev mode in production.
    }
  }
}

In Electron Project

In Vite Project