Prepare npm alpha readiness and README demos#17
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Prepares the repository and codex-claw CLI package for an initial npm alpha release by updating public/package documentation, tightening npm package metadata, and ensuring releases publish under the alpha dist-tag (supporting the intended npx codex-claw@alpha workflow).
Changes:
- Refreshes the root README and the CLI package README with alpha-status messaging,
npx-first guidance, demos, and checklists. - Adds/updates npm package metadata fields (
homepage,bugs,repository, keywords) and setspublishConfig.tagtoalpha. - Updates monorepo scripts to support
npm pack --dry-runinspection and to publish with--tag alpha, plus removes stale “legacy” wording in CLI help.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Reworks public-facing docs to emphasize alpha status, npx target workflow, and operational checklists/demos. |
| packages/codex-claw/README.md | Updates package-level README for alpha npx usage, command reference, and publish checklist. |
| packages/codex-claw/package.json | Hardens npm metadata (repository/bugs/homepage/keywords) and sets alpha dist-tag publish config. |
| packages/codex-claw/bin/codex-claw.js | Updates CLI help text to remove stale “legacy” phrasing for init. |
| package.json | Adds pack:codex-claw and updates release:codex-claw to publish with the alpha dist-tag. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
16
to
+19
| - Node.js 20 or newer | ||
| - pnpm | ||
| - Git | ||
| - Codex CLI installed and logged in | ||
| - pnpm for local development workflows |
This was referenced May 31, 2026
slashdevcorpse
added a commit
that referenced
this pull request
May 31, 2026
Prepare npm alpha readiness and README demos
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:
Validation:
Closes #16
Summary by cubic
Prepares the first npm alpha: refreshed READMEs with demos and
npxinstall guidance, hardened package metadata, and switched the publish flow to thealphadist‑tag. Also cleans up the CLI help text forinit.npxalpha status, terminal demos, and beta-track checklist.npx codex-claw@alphaguidance, local verification commands, command table, and publish checklist.pack:codex-claw;release:codex-clawnow publishes with--tag alpha.publishConfig.tag: alpha.inithelp copy to remove stale “legacy” wording.Written for commit 9beada1. Summary will update on new commits.