Skip to content

Prepare npm alpha readiness and README demos#17

Merged
slashdevcorpse merged 3 commits into
mainfrom
docs/npm-alpha-readiness
May 31, 2026
Merged

Prepare npm alpha readiness and README demos#17
slashdevcorpse merged 3 commits into
mainfrom
docs/npm-alpha-readiness

Conversation

@slashdevcorpse
Copy link
Copy Markdown
Owner

@slashdevcorpse slashdevcorpse commented May 31, 2026

Summary:

  • Upgrades the public README with a centered preview, badges, contents, npx alpha status, terminal demo blocks, and beta-track checklist.
  • Updates the package README with npx alpha install guidance, local source verification commands, command table, and publish checklist.
  • Hardens npm package metadata and changes the release script to publish with the alpha dist-tag.
  • Removes stale CLI help wording from the init command.

Validation:

  • node packages/codex-claw/bin/codex-claw.js --help
  • node packages/codex-claw/bin/codex-claw.js doctor
  • pnpm pack:codex-claw
  • npm publish --dry-run --tag alpha --access public
  • pnpm -C apps/codex-claw test
  • pnpm -C apps/codex-claw build
  • pnpm -C apps/landing build
  • rg legacy source-project names across public surfaces

Closes #16


Summary by cubic

Prepares the first npm alpha: refreshed READMEs with demos and npx install guidance, hardened package metadata, and switched the publish flow to the alpha dist‑tag. Also cleans up the CLI help text for init.

  • New Features
    • Public README: centered preview, badges, contents, npx alpha status, terminal demos, and beta-track checklist.
    • Package README: npx codex-claw@alpha guidance, local verification commands, command table, and publish checklist.
    • Release scripts: added pack:codex-claw; release:codex-claw now publishes with --tag alpha.
    • Package metadata: improved description, keywords, homepage, bugs, repository, and publishConfig.tag: alpha.
    • CLI: updated init help copy to remove stale “legacy” wording.

Written for commit 9beada1. Summary will update on new commits.

Review in cubic

Copilot AI review requested due to automatic review settings May 31, 2026 05:51
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 5 files

Re-trigger cubic

@slashdevcorpse slashdevcorpse merged commit bb20051 into main May 31, 2026
2 of 3 checks passed
@slashdevcorpse slashdevcorpse deleted the docs/npm-alpha-readiness branch May 31, 2026 05:53
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 sets publishConfig.tag to alpha.
  • Updates monorepo scripts to support npm pack --dry-run inspection 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
slashdevcorpse added a commit that referenced this pull request May 31, 2026
Prepare npm alpha readiness and README demos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Harden npm alpha readiness for npx installs

2 participants