docs(install): document local clone+link flow and CI install smoke - #14
Open
Munawarx wants to merge 1 commit into
Open
docs(install): document local clone+link flow and CI install smoke#14Munawarx wants to merge 1 commit into
Munawarx wants to merge 1 commit into
Conversation
The only install path was 'npx github:Nazim22/leadline'; package.json is private so npm publish is not yet available. Add a documented local-install flow (git clone + npm install + npm link) and a CI 'install-smoke' job that proves the CLI links and runs. Also notes Node >=18 and the Linux-only exam harness caveat. Docs/infra only; no engine/contract changes. Co-Authored-By: Hermes Agent <noreply@hermes.ai>
This was referenced Jul 26, 2026
Contributor
Author
|
Tracking our current contribution set for Leadline (Munawarx). All are independent, each on its own branch:
Each PR is self-contained and ready to review independently. Happy to split, adjust, or rebase any of them. Co-Authored-By: Hermes Agent noreply@hermes.ai |
This was referenced Jul 26, 2026
Nazim22
requested changes
Aug 3, 2026
Nazim22
left a comment
Owner
There was a problem hiding this comment.
Verified: two blockers. (1) The documented "dry-run" flow actually writes 7 files (settings.json hooks, .leadline/config.yaml + packs) — that's upstream bug #18, being fixed; these docs should land AFTER so they document the corrected behavior. (2) The CI smoke leadline --help || leadline init --claude-code --dry-run short-circuits — --help exits 0 so the init path is never exercised. Deferring until #18 ships; a rebase then would be welcome.
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
Makes Leadline installable without the
npx github:specifier.package.jsonisprivate: true, so an npm package isn't publishable yet; this adds a documented local install path plus a CI job that proves it.Changes
git clone && npm install && npm linkflow so theleadlinecommand is available from a current checkout, and a note that the npm package is still on the roadmap. Document the Node ≥ 18 requirement and the Linux-only exam harness caveat..github/workflows/ci.yml: add aninstall-smokejob (ubuntu-latest, Node 20) that runsnpm ci→npm link→ invokes theleadlineCLI, proving the documented install path works on a clean runner.Why
Contributors on non-Linux hosts (and anyone who wants a pinned local copy) had only the GitHub-specifier install. A reproducible local install lowers the contribution barrier and is the interim step before a published npm package.
Verification
npm link+ the CLI.Trade-offs
private: true(no published package yet) — the clone+link path is the supported interim. When the maintainer is ready to publish, flippingprivate: false+ addingprepare/version tagging is the follow-up.Files
README.md.github/workflows/ci.ymlCo-Authored-By: Hermes Agent noreply@hermes.ai