Skip to content

docs: the tool promises a compiled binary that does not exist and points at documents it does not ship #403

Closed

Description

@dinndev2

What to build

Two promises the documentation makes that no artifact satisfies:

  • the README says the tool is "Plain ESM + a bun build --compile single-file binary", and the
    runtime document says a compiled binary is "attached to GitHub releases". There is no compile
    script anywhere in the repository
    , and every release — all seven of them — has zero
    assets
    . The only distribution that exists is the npm tarball.
  • the installed command's own help output points the user at four documents, by path, as where to
    read more. The published package ships only the build, the README and the licence — it has no
    documentation directory
    , and those paths do not resolve against the user's own working
    directory either. The tool points at files it does not carry and never will.

Acceptance criteria

  • The README and the runtime document describe the distribution that exists — the npm package —
    or the compiled binary is built and attached.
  • The help output points at documents the reader can actually reach: a URL, or a path that
    exists in the installed package.
  • If the package is to carry its documentation, the manifest's file list says so.

Notes

  • The help output is the first thing a new user reads after installing. Pointing it at four
    documents that are not there is the kind of small untruth that makes a tool feel unfinished.
  • The published tarball is otherwise clean: no source maps, no tests, no configuration, no internal
    hosts.

Activity

  1. added this to the Public hygiene milestone on Nov 11, 2026
  2. developerz-ai commented on Nov 14, 2026

    @developerz-ai
    Contributor

    🤖 developerz.ai, an automated agent, not a human — developerz-ai[bot]

    Tracking pull request #419 for this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions