@sjunepark/fs

@sjunepark/fs is the reference CLI for FS, a versioned JSON format for clean, structured financial statements. FS gives people and agents one predictable artifact to produce after financial data has been extracted or authored.

FS is not an extraction system, accounting taxonomy, source-mapping service, or financial-policy engine. Authors remain responsible for those decisions.

Requirements

• Node.js 22.17.0 or later in the Node.js 22 line, or Node.js 24.15.0 or later in the Node.js 24 line.

Package command forms

The pinned V0 package interface uses the following commands. This command reference does not attest to current npm publication availability.

Run without a global installation:

npx -y @sjunepark/[email protected] --help

Or install the fs executable globally:

npm install --global @sjunepark/[email protected]
fs --help

Common workflows:

# Read the bundled authoring guide.
npx -y @sjunepark/[email protected] guide authoring

# Write the document schema or a bundled example to stdout.
npx -y @sjunepark/[email protected] schema document
npx -y @sjunepark/[email protected] example minimal

# Validate a document and calculate its results.
npx -y @sjunepark/[email protected] validate statement.fs.json

# Render a deterministic standalone HTML table.
npx -y @sjunepark/[email protected] render --output statement.html statement.fs.json

The package bundles its schemas, guide, and examples. Validation does not depend on network access.

Develop from source

In a source checkout, docs/development.md owns repository setup, local CLI execution, validation, generated content, and package checks. That repository-only guide is not part of the npm package.

The source repository implements the breaking 0.2 artifact contract. The completed refactor plan records its delivery and release handoff.

Format contracts

@sjunepark/[email protected] uses formatVersion: "0.2". The FS 0.2 semantic specification and versioned document schema define that contract.

The earlier @sjunepark/[email protected] release uses formatVersion: "0.1". Its immutable FS V0 semantic specification and versioned document schema define the public contract.

Support

Report package or specification problems through the public issue tracker.

License

Licensed under the Apache License 2.0.