Skip to content

docs(cli): improve package discoverability - #606

Merged
Aymericr merged 1 commit into
mainfrom
docs/cli-discoverability
Aug 7, 2026
Merged

docs(cli): improve package discoverability#606
Aymericr merged 1 commit into
mainfrom
docs/cli-discoverability

Conversation

@Aymericr

@Aymericr Aymericr commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the terse CLI package README with a complete npm landing page
  • add richer npm description, search keywords, author, and public-package metadata
  • remove stale pre-release language from repository setup docs
  • make the CLI and MCP packages discoverable from the repository README
  • distinguish hosted MCP from the local open-source MCP package

Verification

  • bunx biome check package.json packages/cli/package.json packages/cli/src packages/cli/scripts
  • bun run --cwd packages/cli check-types
  • bun test packages/cli/src (20 passed)
  • npm pack --ignore-scripts --dry-run --json (README and LICENSE included)

Note

Low Risk
Documentation and package.json metadata only; no application or CLI runtime code changes.

Overview
Documentation and npm metadata to present @pascal-app/cli and @pascal-app/mcp as shipped products, without changing runtime behavior.

The packages/cli/README.md is rewritten from a short note into a full npm landing page: value prop, requirements, install paths (npx/pnpm/bun/global), command table, ~/.pascal/ layout, security notes, and links to plugins, hosted MCP, and support.

packages/cli/package.json gets a clearer description, extra keywords (e.g. 3d-editor, bim, local-first), author and publishConfig.access: public.

Root README.md and SETUP.md drop “when the CLI is available on npm” wording and add a CLI npm badge, packages/mcp in the monorepo tree, and a responsibility row for @pascal-app/mcp.

packages/mcp/README.md adds a short intro that hosted MCP (account projects) differs from this local open-source server.

Reviewed by Cursor Bugbot for commit d926016. Bugbot is set up for automated code reviews on this repo. Configure here.

@Aymericr
Aymericr merged commit 83ee1f5 into main Aug 7, 2026
4 checks passed
@Aymericr
Aymericr deleted the docs/cli-discoverability branch August 7, 2026 04:08
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.

1 participant