chore: fix package.json conventions and overhaul all READMEs for pgpm#7
Merged
pyramation merged 4 commits intomainfrom Apr 16, 2026
Merged
Conversation
- Remove dist/ prefix anti-pattern from rag and worker packages - Remove exports map anti-pattern from worker package - Mark provision, worker as private - Rename agentic-db -> @agentic-db/db (npm name only, pgpm control file unchanged) - Rename agentic-db-services -> @agentic-db/services (npm name only) - Make @agentic-db/db, @agentic-db/services, @agentic-db/cli publishable (public) - Add main/module/types + publishConfig to @agentic-db/cli - Update repo URLs from pyramation-studio/agent-os to constructive-io/agentic-db
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
- Flagship packages/agentic-db/README.md: comprehensive pgpm + Constructive intro with quick start, Docker Compose setup, search capabilities, SDK examples - Root README.md: updated package table, pgpm quick start, schema dev workflow - @agentic-db/services: pgpm deployment instructions and module dependencies - @agentic-db/sdk: install, CRUD, vector/unified/chunk search examples - @agentic-db/cli: install, setup, usage examples, command reference - Private packages: provision, export, rag, worker, integration-tests, cli-e2e-tests - Revert package name from @agentic-db/db back to plain agentic-db (naked name) - Fix stale badge URLs (pyramation-studio/agent-os -> constructive-io/agentic-db)
pgpm docker start already defaults to constructiveio/postgres-plus:18 with 2GB shared memory. Docker Compose is now documented as an optional extra for Ollama embedding generation only.
Now that pgpm supports --ollama and --gpu flags, update READMEs to show the pgpm-native way to start Ollama. Docker Compose is kept as a secondary option for users who already have their own LLM running or want tuned Postgres settings.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two sets of changes:
1. Package.json convention fixes
Aligns all
package.jsonfiles with the Constructive publishing standards — removing anti-patterns, scoping npm names under@agentic-db/, and clarifying which packages are publishable vs private.Anti-pattern fixes:
packages/rag— removeddist/prefix frommain/module/types(contradicted its ownpublishConfig.directory: "dist")packages/worker— removeddist/prefix, removedexportsmap, addedpublishConfig.directory: "dist"Privacy & publishability:
provisionandworkerasprivate: true@agentic-db/clipublishable with standardmain/module/types+publishConfigaccessfrom"restricted"to"public"foragentic-dband@agentic-db/servicesnpm name renames (pgpm control files unchanged):
agentic-db-services→@agentic-db/servicesagentic-dbstays asagentic-db(naked name, no scope — this is the flagship entry point for pgpm)Housekeeping:
pyramation-studio/agent-os→constructive-io/agentic-db2. README overhaul — pgpm deployment showcase
Rewrote all README files to showcase pgpm deployment and introduce users to the Constructive platform. All READMEs use
pgpm docker startas the primary PostgreSQL setup path, withpgpm docker start --ollamafor embedding generation and Docker Compose as a secondary alternative.Flagship:
packages/agentic-db/README.md— comprehensive intro to pgpm + Constructive with quick start, module dependency tree, search capabilities table, and SDK code examples. Ollama section showspgpm docker start --ollama(CPU) and--ollama --gpu(NVIDIA), with Docker Compose as fallback for users who already have their own LLM running.Published packages:
packages/agentic-db-services/README.md— services module purpose, pgpm deploy instructionssdk/sdk/README.md— install, CRUD, vector/unified/chunk search, relations examplessdk/cli/README.md(new) — install, setup, usage examples with all search typesPrivate packages:
packages/provision/README.md— blueprint schema definitions, provision→export→deploy workflowpackages/rag/README.md— RAG CLI tools (search, embed, ask)packages/worker/README.md— auto-embedding worker architecture, referencespgpm docker start --ollamapackages/integration-tests/README.md(new) — test suite overviewpackages/cli-e2e-tests/README.md(new) — e2e test suite overviewRoot README.md — pgpm quick start, published/private package table, Docker setup section showing
pgpm dockercommands (including--ollamaand--gpu), Docker Compose as alternative, schema development workflow, testing instructions.Review & Testing Checklist for Human
--ollama/--gpuflags depend on constructive-io/constructive#981 — READMEs referencepgpm docker start --ollamaand--ollama --gpu, which require the Constructive PR to be merged and pgpm to be republished. Until then, users following these instructions will get an unknown flag error. Merge the Constructive PR first, or adjust the README wording to note these flags are upcoming.bin+publishConfig.directoryinteraction —binpoints to./generated/cli/index.jsbutpublishConfig.directoryisdist. When published, npm will resolvebinrelative todist/— confirmdist/generated/cli/index.jswill exist aftermakage buildcreateClient,findMany,vectorEmbedding,searchScoreAPI shapes match the actual generated SDK../../sdk/sdkand../../sdk/cli; root README links topackages/agentic-dbetc. Verify these resolve correctly on GitHubNotes
.controlfiles are intentionally left unchanged —pgpm deployuses control file names, not npm package nameslibcfield removals in the lockfile are pnpm normalization noise, not functional changes@agentic-db/ragkeepspublishConfig.access: "public"despite beingprivate: true— harmless but inconsistent; consider removingpublishConfigentirely from private packagesLink to Devin session: https://app.devin.ai/sessions/f70461c2d0a74993a271488c3aa077b1
Requested by: @pyramation