11# Installing Lore as a Dev Dependency
22
3+ ` @makenotion/lore ` is publicly available from npm without registry or token
4+ setup.
5+
36Teams that want every engineer's checkout to share the same Lore config can
47pin ` @makenotion/lore ` as a devDependency and commit assistant config alongside
58the rest of the repo. Yarn PnP is the fully path-portable shape: no absolute
6- paths land in committed MCP config, so the same files work on every
7- engineer's checkout.
8-
9- Lore releases are still internal-only on GitHub Packages. The public npm
10- cutover is parked until the team finishes one or two more internal releases,
11- so fresh installs still need a GitHub Packages token and an ` @makenotion `
12- registry mapping.
13-
14- ## GitHub Packages Access
15-
16- If you're already authed with the [ ` gh ` CLI] ( https://cli.github.com/ ) :
17-
18- ``` bash
19- gh auth refresh -h github.com -s read:packages
20-
21- # zsh
22- echo ' export GITHUB_PACKAGES_TOKEN="$(gh auth token)"' >> ~ /.zshrc
23- source ~ /.zshrc
24-
25- # bash
26- echo ' export GITHUB_PACKAGES_TOKEN="$(gh auth token)"' >> ~ /.bashrc
27- source ~ /.bashrc
28- ```
29-
30- That's it. ` gh ` already manages the token; you just expose it under the name
31- ` .yarnrc.yml ` / ` .npmrc ` reads.
32-
33- If you don't use the ` gh ` CLI, or your org disables OAuth tokens for packages,
34- create a classic Personal Access Token instead:
35-
36- 1 . Visit < https://github.com/settings/tokens/new > .
37- 2 . Scope: ** ` read:packages ` ** .
38- 3 . ` export GITHUB_PACKAGES_TOKEN=<the-token> ` in your shell rc.
39-
40- Both forms produce a token GitHub Packages accepts as a Bearer token.
9+ paths land in committed MCP config, so the same files work on every engineer's
10+ checkout.
4111
4212## Wiring the Consumer Repo
4313
44- 1 . ** Configure the registry mapping.** For Yarn 4 / Berry, add to
45- ` .yarnrc.yml ` :
46-
47- ``` yaml
48- npmScopes :
49- makenotion :
50- npmRegistryServer : " https://npm.pkg.github.com"
51- npmAuthToken : " ${GITHUB_PACKAGES_TOKEN:-}"
52- ` ` `
53-
54- For npm / Yarn 1, copy ` .npmrc.example` and adapt it, or make sure
55- `~/.npmrc` contains :
56-
57- ` ` ` ini
58- @makenotion:registry=https://npm.pkg.github.com
59- //npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_TOKEN}
60- ` ` `
61-
62- The `${VAR:-}` default-value form in Yarn config is load-bearing : it lets
63- unrelated yarn invocations (`yarn run -T lore mcp`, `yarn lint`, etc.) load
64- the file without a token. Only registry fetches need it.
65-
66- 2. **Add the devDep.**
14+ 1 . ** Add the devDependency.**
6715
6816 ``` bash
6917 yarn add -D @makenotion/lore # or `npm install -D @makenotion/lore`
7018 ```
7119
72- 3 . ** Run ` lore install ` once locally.** From inside the consumer repo:
20+ 2 . ** Run ` lore install ` once locally.** From inside the consumer repo:
7321
7422 ``` bash
7523 yarn run -T lore install -y # Yarn PnP consumers
@@ -95,21 +43,22 @@ Both forms produce a token GitHub Packages accepts as a Bearer token.
9543 (PnP) or
9644 ` "command": "cd \"$CLAUDE_PROJECT_DIR\" && lore hooks <event>" ` (npm).
9745
98- 4 . ** Teach the repo's agents to prefer Lore.** Add a short "Memory and
46+ 3 . ** Teach the repo's agents to prefer Lore.** Add a short "Memory and
9947 note-taking" section to the repo's ` AGENTS.md ` and ` CLAUDE.md ` so agents know
10048 when to call Lore tools instead of writing local-only notes. See
10149 [ Quick Start step 6] ( ../README.md#6-teach-your-agents-to-use-lore ) for a
10250 pasteable starter.
10351
104- 5 . ** Commit the project-local diff.** Under the default ` --client all ` flow,
52+ 4 . ** Commit the project-local diff.** Under the default ` --client all ` flow,
10553 commit the generated ` .mcp.json ` , ` .codex/config.toml ` , ` .codex/hooks.json ` ,
10654 ` .cursor/mcp.json ` , and docs changes that landed in the repo.
10755
108- ** Yarn PnP consumers** : the committed files Just Work on any teammate's
109- fresh checkout. ` yarn install ` resolves ` @makenotion/lore ` from GitHub
110- Packages using each engineer's ` GITHUB_PACKAGES_TOKEN ` , and host assistants
111- resolve ` lore ` through Yarn's PnPAPI. No absolute paths or ` ${HOME} `
112- placeholders land in the project-local MCP config.
56+
57+ ** Yarn PnP consumers** : the committed files work on any teammate's fresh
58+ checkout. ` yarn install ` resolves ` @makenotion/lore ` from npm without
59+ credentials, and host assistants resolve ` lore ` through Yarn's PnPAPI. No
60+ absolute paths or ` ${HOME} ` placeholders land in the project-local MCP
61+ config.
11362
11463 ** npm / Yarn 1 consumers** : the committed MCP config carries a static
11564 ` LORE_CONFIG_ROOT=<checkout-path> ` so hosts can launch ` lore mcp ` from
0 commit comments