docs: add READMEs for @sawala/cli + @sawala/mcp (re-trigger publish)#35
Merged
Conversation
Both packages' first releases (0.1.0) declared `README.md` in their
files array but had no such file in the source, so the npm tarballs
shipped with only package.json + dist/ — the npmjs.com listings
showed no description.
This commit adds:
packages/sawala/README.md installation, command reference,
config, env vars, MCP companion link
packages/sawala-mcp/README.md installation, host configuration
snippets (Claude Desktop / Claude Code
/ Cursor / local-build testing), tool
table by service, auth env vars
Both READMEs mirror the structure of @sawala/kodena and
@sawala/kodena-mcp so users hopping between the two CLIs see a
consistent shape.
A changeset (.changeset/sawala-readmes.md) bumps both to patch
(0.1.0 → 0.1.1) so the changesets/OIDC release workflow re-publishes
with the README content included. Verified with `npm pack --dry-run`:
both tarballs now report 3 files including README.md.
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
2 participants
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
The first releases of
@sawala/cli@0.1.0and@sawala/mcp@0.1.0shipped without their READMEs. Theirpackage.jsondeclaredREADME.mdin thefilesarray but no such file existed in the package source, so the npm tarballs contained onlypackage.json+dist/and the npmjs.com listings showed no documentation.What changes
packages/sawala/README.md— installation, full command reference grouped by service (identity, Kontena, Formulir, Berkasna), local state layout, env vars, MCP companion link.packages/sawala-mcp/README.md— installation, host configuration snippets for Claude Desktop / Claude Code / Cursor / local-build testing, complete tool table by service with the underlyingGETpaths, auth env vars.Both READMEs mirror the shape of
@sawala/kodenaand@sawala/kodena-mcpso users moving between the two CLIs see a consistent layout.Changeset
.changeset/sawala-readmes.mdbumps both to patch:@sawala/cli0.1.1@sawala/mcp0.1.1This triggers the existing changesets/OIDC release workflow to re-publish both packages with the README content included.
Verified
npx changeset status— confirms only the two sawala packages get bumped, nothing else.npm pack --dry-runin each package:@sawala/cli@0.1.0tarball: 3 files (README.md5.6kB +dist/cli.js1.5MB +package.json1.2kB)@sawala/mcp@0.1.0tarball: 3 files (README.md6.4kB +dist/server.js2.1MB +package.json1.2kB)npm run build --workspace @sawala/cli --workspace @sawala/mcp— both bundles still build cleanly.Audit of all currently-published packages (for context)
latest@sawala/kodenadist,package.json,README.md@sawala/kodena-mcpdist,package.json,README.md@sawala/clidist,package.json(no README)@sawala/mcpdist,package.json(no README)@sawala/authFollow-up after merge
The changesets bot will open its standard "Version Packages" PR. Merging that PR triggers the OIDC trusted-publish of
@sawala/cli@0.1.1and@sawala/mcp@0.1.1.https://claude.ai/code/session_01EA6ABHFn71huLrMHtSB6A4
Generated by Claude Code