Skip to content

Latest commit

 

History

History
80 lines (54 loc) · 2.33 KB

File metadata and controls

80 lines (54 loc) · 2.33 KB

Section npm Distribution

Direct Recommendation

Publish a scoped CLI package:

  • npm package: @eric8810/section

That gives Section two real install surfaces from the same package:

npm install -g @eric8810/section
section --help
sectiond inspect
npx --package @eric8810/section section --help

Why this route

  • npm is an install surface, not just a JS ecosystem channel
  • it gives a low-friction CLI install story for users already living in Node tooling
  • it gives an npx entry for one-shot use
  • it does not force Section to promise a JavaScript SDK

Official references:

Package Model

The npm package is a thin distribution layer:

  • publish the npm package once
  • on install, download the matching GitHub Release binary archive
  • expose section and sectiond through npm bin shims

This keeps the product line clear:

  • Rust binaries remain the real product artifacts
  • npm remains an install surface
  • Section still does not become a JS SDK by accident

Current Binary Targets

The first npm package should support these release archives:

  • section-<version>-darwin-arm64.tar.gz
  • section-<version>-darwin-x64.tar.gz
  • section-<version>-linux-arm64.tar.gz
  • section-<version>-linux-x64.tar.gz

Each archive should extract to:

  • bin/section
  • bin/sectiond

Files in This Package

Current Boundary

This task prepares the npm install surface and publishable package skeleton.

It does not yet:

  • publish the package to npm
  • build or attach the release archives automatically
  • promise a Windows npm install path before Windows binaries exist
  • promise a JavaScript or TypeScript SDK