mirror of
https://github.com/profullstack/logicsrc.git
synced 2026-08-13 22:37:29 +00:00
Point install docs at @logicsrc/opencontext; record the npm name collision
The unscoped `opencontext` name is already published on npm by an unrelated third party (federicodeponte/opencontext, 2.0.0), so `npx opencontext` would install a stranger's package. Docs now use `npx @logicsrc/opencontext`; the bin stays named `opencontext` so the command reads as the PRD specifies once installed. Recorded in PRD 0003 as a blocker to resolve before any publication, along with the fact that no @logicsrc spec package has ever been published, so there is no existing release path to slot into. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
ec3ed64f20
commit
dc56e4c741
7 changed files with 31 additions and 17 deletions
|
|
@ -116,9 +116,9 @@ replaceable workers without losing institutional state.
|
||||||
> An agent should be replaceable without losing organizational knowledge.
|
> An agent should be replaceable without losing organizational knowledge.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx opencontext init my-context
|
npx @logicsrc/opencontext init my-context
|
||||||
npx opencontext validate --strict
|
npx @logicsrc/opencontext validate --strict
|
||||||
npx opencontext resolve --role support --task "customer asked for a refund" --explain
|
npx @logicsrc/opencontext resolve --role support --task "customer asked for a refund" --explain
|
||||||
```
|
```
|
||||||
|
|
||||||
```txt
|
```txt
|
||||||
|
|
|
||||||
|
|
@ -37,7 +37,7 @@ Everything in OpenContext is one of five things.
|
||||||
Five minutes, no account, no network, no model key.
|
Five minutes, no account, no network, no model key.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx opencontext init my-context
|
npx @logicsrc/opencontext init my-context
|
||||||
cd my-context
|
cd my-context
|
||||||
|
|
||||||
opencontext validate --strict
|
opencontext validate --strict
|
||||||
|
|
@ -343,8 +343,8 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- run: npx opencontext validate --strict
|
- run: npx @logicsrc/opencontext validate --strict
|
||||||
- run: npx opencontext doctor --strict
|
- run: npx @logicsrc/opencontext doctor --strict
|
||||||
```
|
```
|
||||||
|
|
||||||
Exit codes are stable: `0` ok, `1` invalid, `2` usage, `3` not found.
|
Exit codes are stable: `0` ok, `1` invalid, `2` usage, `3` not found.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# CLI reference
|
# CLI reference
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx opencontext <command> # standalone
|
npx @logicsrc/opencontext <command> # standalone
|
||||||
logicsrc context <command> # inside the LogicSRC CLI
|
logicsrc context <command> # inside the LogicSRC CLI
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -245,9 +245,9 @@ opencontext version # the supported specification version
|
||||||
## CI
|
## CI
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- run: npx opencontext validate --strict
|
- run: npx @logicsrc/opencontext validate --strict
|
||||||
- run: npx opencontext doctor --strict
|
- run: npx @logicsrc/opencontext doctor --strict
|
||||||
- run: npx opencontext bundle --role support --output bundle.json
|
- run: npx @logicsrc/opencontext bundle --role support --output bundle.json
|
||||||
```
|
```
|
||||||
|
|
||||||
Common gates:
|
Common gates:
|
||||||
|
|
|
||||||
|
|
@ -129,7 +129,7 @@ No. OpenContext is independently usable, and the specification does not depend o
|
||||||
### Where do I start?
|
### Where do I start?
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx opencontext init my-context
|
npx @logicsrc/opencontext init my-context
|
||||||
```
|
```
|
||||||
|
|
||||||
Then read [`examples/opencontext/minimal`](../../examples/opencontext/minimal), and when you have two roles that need different things, read [`multi-agent-company`](../../examples/opencontext/multi-agent-company).
|
Then read [`examples/opencontext/minimal`](../../examples/opencontext/minimal), and when you have two roles that need different things, read [`multi-agent-company`](../../examples/opencontext/multi-agent-company).
|
||||||
|
|
|
||||||
|
|
@ -108,9 +108,9 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- run: npx opencontext validate --strict
|
- run: npx @logicsrc/opencontext validate --strict
|
||||||
- run: npx opencontext doctor --strict
|
- run: npx @logicsrc/opencontext doctor --strict
|
||||||
- run: npx opencontext bundle --role support --output bundle.json
|
- run: npx @logicsrc/opencontext bundle --role support --output bundle.json
|
||||||
- uses: actions/upload-artifact@v4
|
- uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: context-bundle
|
name: context-bundle
|
||||||
|
|
|
||||||
|
|
@ -15,9 +15,9 @@ Five working [OpenContext](../../docs/opencontext.md) repositories. Every one is
|
||||||
```bash
|
```bash
|
||||||
cd minimal
|
cd minimal
|
||||||
|
|
||||||
npx opencontext validate --strict
|
npx @logicsrc/opencontext validate --strict
|
||||||
npx opencontext doctor
|
npx @logicsrc/opencontext doctor
|
||||||
npx opencontext resolve --role everyone --format markdown
|
npx @logicsrc/opencontext resolve --role everyone --format markdown
|
||||||
```
|
```
|
||||||
|
|
||||||
Or from anywhere, since discovery searches upward:
|
Or from anywhere, since discovery searches upward:
|
||||||
|
|
|
||||||
|
|
@ -183,6 +183,20 @@ that quietly diverged would become a second contract.
|
||||||
- **Digest churn.** A resolver bug fix that changes what is selected changes
|
- **Digest churn.** A resolver bug fix that changes what is selected changes
|
||||||
bundle digests, which a consumer might read as tampering. Mitigated by calling
|
bundle digests, which a consumer might read as tampering. Mitigated by calling
|
||||||
such fixes out explicitly in the changelog.
|
such fixes out explicitly in the changelog.
|
||||||
|
- **Blocker: the `opencontext` npm name is taken.** This PRD proposes
|
||||||
|
`opencontext` as the package name and `npx opencontext` as the install path.
|
||||||
|
That name is already published by an unrelated third party
|
||||||
|
(`federicodeponte/opencontext`, currently 2.0.0, "AI-powered company context
|
||||||
|
analysis from your terminal") — and being adjacent in subject matter makes the
|
||||||
|
confusion worse, not better. Documentation therefore ships pointing at
|
||||||
|
`npx @logicsrc/opencontext`, and the `bin` is still named `opencontext` so the
|
||||||
|
command reads as specified once installed. Resolving this needs a decision
|
||||||
|
before any publication: request a transfer, pick a different unscoped name, or
|
||||||
|
commit to the scoped package permanently.
|
||||||
|
- **No publication pipeline exists yet.** Neither `@logicsrc/openprd` nor
|
||||||
|
`@logicsrc/openontology` has ever been published to npm, so OpenContext is not
|
||||||
|
slotting into an established release path — one has to be built. Until then
|
||||||
|
the only distribution is this repository.
|
||||||
- **Open question.** Should interior wildcards (`customers.*.churn-risk`) remain
|
- **Open question.** Should interior wildcards (`customers.*.churn-risk`) remain
|
||||||
single-segment only, or should a future minor version add a bounded multi-
|
single-segment only, or should a future minor version add a bounded multi-
|
||||||
segment form? Single-segment is shipped in v1 because the alternative silently
|
segment form? Single-segment is shipped in v1 because the alternative silently
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue