edgar-cli 0.1.4 → 0.2.2

package/README.md

@@ -1,141 +1,11 @@
 # edgar-cli
 
-Agent-friendly SEC EDGAR CLI for filings and company facts.
+Go-native SEC EDGAR CLI for `npx` workflows.
 
-## Features
-
-- `npx`-friendly Node/TypeScript package (no Python runtime needed)
-- JSON envelope output by default for stable automation
-- Strict SEC identity enforcement (`--user-agent` or `EDGAR_USER_AGENT`)
-- Core commands:
-  - `resolve`
-  - `filings list`
-  - `filings get`
-  - `facts get`
-  - `research sync`
-  - `research ask`
-
-## Install / Run
+This package is a small Node launcher that dispatches to a prebuilt native Go binary for the current platform.
 
 ```bash
 npx edgar-cli --help
 ```
 
-Local development:
-
-```bash
-npm install
-npm run build
-node dist/cli.js --help
-```
-
-## SEC Identity Requirement
-
-SEC endpoints require declared automated access identity.
-
-Use either:
-
-```bash
-export EDGAR_USER_AGENT="Your Name your.email@example.com"
-```
-
-Or pass per command:
-
-```bash
-npx edgar-cli --user-agent "Your Name your.email@example.com" resolve AAPL
-```
-
-If identity is missing, commands fail with `IDENTITY_REQUIRED`.
-
-## Examples
-
-```bash
-# Resolve ticker -> canonical SEC identity mapping
-npx edgar-cli --user-agent "Your Name your.email@example.com" resolve AAPL
-
-# List recent 10-K filings
-npx edgar-cli --user-agent "Your Name your.email@example.com" filings list --id AAPL --form 10-K --query-limit 5
-
-# Get filing document URL by accession
-npx edgar-cli --user-agent "Your Name your.email@example.com" filings get --id AAPL --accession 0000320193-26-000006 --format url
-
-# Get filing converted to Markdown
-npx edgar-cli --user-agent "Your Name your.email@example.com" filings get --id AAPL --accession 0000320193-26-000006 --format markdown
-
-# Get concept data (latest per unit)
-npx edgar-cli --user-agent "Your Name your.email@example.com" facts get --id AAPL --taxonomy us-gaap --concept Revenues --latest
-
-# Query explicit local docs (repeat --doc or pass --manifest)
-npx edgar-cli research ask "board resignation details" --doc ./cache/nvda-8k.md --top-k 5
-
-# Build a deterministic cached corpus for a ticker/profile
-npx edgar-cli --user-agent "Your Name your.email@example.com" research sync --id NVDA --profile core
-
-# Query by ticker against cached corpus (auto-syncs on cache miss)
-npx edgar-cli --user-agent "Your Name your.email@example.com" research ask "what changed on the board?" --id NVDA --profile core
-
-# Query latest filing(s) in one shot: discover -> fetch/cache -> search
-npx edgar-cli --user-agent "Your Name your.email@example.com" research ask "gross margin drivers" --id AAPL --form 10-Q --latest 1
-```
-
-## Research Profiles and Cache
-
-`research sync` and `research ask --id` use deterministic filing profiles:
-
-- `core`: latest 1x `10-K`, latest 3x `10-Q`, and recent `8-K` (last 180 days, up to 12)
-- `events`: recent `8-K` (last 365 days, up to 24)
-- `financials`: latest 2x `10-K` and latest 6x `10-Q`
-
-By default, cached corpora are stored in:
-
-- `$EDGAR_CACHE_DIR` (if set), else
-- `$XDG_CACHE_HOME/edgar-cli` (if set), else
-- `~/.cache/edgar-cli`
-
-Override per command with `--cache-dir`.
-
-When using `research ask --id`, you can also scope discovery directly:
-
-- `--form <form>` to filter filings by form type (e.g. `10-Q`)
-- `--latest <n>` to limit selection to the latest N filings after filters
-
-## Output Contract (default)
-
-All JSON-mode commands emit:
-
-```json
-{
-  "ok": true,
-  "command": "resolve",
-  "provider": "sec",
-  "data": {},
-  "error": null,
-  "meta": {
-    "timestamp": "2026-02-11T00:00:00Z",
-    "output_schema": "v1",
-    "view": "summary"
-  }
-}
-```
-
-## Compliance Notes
-
-- This CLI targets SEC-hosted endpoints only in V0.
-- Respect SEC fair-access guidance and use a valid identity in your user-agent.
-
-References:
-
-- [SEC Developer](https://www.sec.gov/developer)
-- [SEC Webmaster FAQ: code support](https://www.sec.gov/os/webmaster-faq#code-support)
-
-## Security
-
-See [`SECURITY.md`](SECURITY.md) for vulnerability reporting guidance.
-
-## Development
-
-```bash
-npm run typecheck
-npm run test
-npm run build
-```
+See the repository README for command examples and compliance notes.

package/bin/edgar-lib.cjs

@@ -0,0 +1,118 @@
+const { spawnSync } = require("node:child_process");
+const fs = require("node:fs");
+const path = require("node:path");
+
+const NATIVE_TARGETS = {
+  "darwin-arm64": {
+    packageName: "edgar-cli-darwin-arm64",
+    binaryRelPath: "bin/edgar"
+  },
+  "linux-x64": {
+    packageName: "edgar-cli-linux-x64",
+    binaryRelPath: "bin/edgar"
+  }
+};
+
+function targetKey(platform, arch) {
+  return `${platform}-${arch}`;
+}
+
+function resolveNativeBinary({
+  platform = process.platform,
+  arch = process.arch,
+  requireResolve = require.resolve,
+  exists = fs.existsSync,
+  baseDir = __dirname
+} = {}) {
+  const key = targetKey(platform, arch);
+  const spec = NATIVE_TARGETS[key];
+
+  if (!spec) {
+    return {
+      supported: false,
+      key,
+      packageName: null,
+      binaryPath: null
+    };
+  }
+
+  const localNodeModulesBinary = path.resolve(
+    baseDir,
+    "..",
+    "node_modules",
+    spec.packageName,
+    spec.binaryRelPath
+  );
+  if (exists(localNodeModulesBinary)) {
+    return {
+      supported: true,
+      key,
+      packageName: spec.packageName,
+      binaryPath: localNodeModulesBinary
+    };
+  }
+
+  try {
+    const binaryPath = requireResolve(`${spec.packageName}/${spec.binaryRelPath}`);
+
+    return {
+      supported: true,
+      key,
+      packageName: spec.packageName,
+      binaryPath
+    };
+  } catch (error) {
+    if (error && error.code === "MODULE_NOT_FOUND") {
+      return {
+        supported: true,
+        key,
+        packageName: spec.packageName,
+        binaryPath: null
+      };
+    }
+    throw error;
+  }
+}
+
+function runEdgar({
+  argv,
+  env = process.env,
+  spawn = spawnSync,
+  stderr = process.stderr,
+  platform = process.platform,
+  arch = process.arch,
+  resolveNative = resolveNativeBinary
+}) {
+  const native = resolveNative({ platform, arch });
+
+  if (!native.supported) {
+    stderr.write(`edgar-cli native runtime is not available for ${native.key}.\n`);
+    return 1;
+  }
+
+  if (!native.binaryPath) {
+    stderr.write(`edgar-cli native runtime package missing: ${native.packageName}\n`);
+    stderr.write("Reinstall with optional dependencies enabled, then retry `npx edgar-cli --help`.\n");
+    return 1;
+  }
+
+  const result = spawn(native.binaryPath, argv, { stdio: "inherit", env });
+  if (result.error) {
+    stderr.write(`edgar-cli native launcher failed: ${result.error.message}\n`);
+    return 1;
+  }
+  if (typeof result.status === "number") {
+    return result.status;
+  }
+  if (result.signal) {
+    stderr.write(`edgar-cli native launcher terminated by signal ${result.signal}\n`);
+    return 1;
+  }
+  return 1;
+}
+
+module.exports = {
+  NATIVE_TARGETS,
+  resolveNativeBinary,
+  runEdgar
+};

package/bin/edgar.cjs

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+const { runEdgar } = require("./edgar-lib.cjs");
+
+const exitCode = runEdgar({ argv: process.argv.slice(2) });
+process.exit(exitCode);

package/package.json

@@ -1,63 +1,49 @@
 {
   "name": "edgar-cli",
-  "version": "0.1.4",
-  "description": "Agent-friendly SEC EDGAR CLI",
+  "version": "0.2.2",
+  "description": "Go-native SEC EDGAR CLI for npx",
   "license": "MIT",
-  "type": "module",
+  "type": "commonjs",
   "publishConfig": {
     "access": "public"
   },
   "bin": {
-    "edgar-cli": "dist/cli.js",
-    "edgar": "dist/cli.js"
+    "edgar-cli": "bin/edgar.cjs",
+    "edgar": "bin/edgar.cjs"
   },
   "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
+    "bin",
+    "README.md"
   ],
   "engines": {
     "node": ">=18"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/finlayi/edgar-cli.git"
+    "url": "git+https://github.com/finlayi/edgar-cli.git",
+    "directory": "npm"
   },
   "homepage": "https://github.com/finlayi/edgar-cli#readme",
   "bugs": {
     "url": "https://github.com/finlayi/edgar-cli/issues"
   },
-  "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "dev": "tsx src/cli.ts",
-    "test": "vitest run",
-    "lint": "eslint . --ext .ts",
-    "typecheck": "tsc --noEmit"
-  },
   "keywords": [
     "edgar",
     "sec",
     "cli",
     "npx",
-    "filings"
+    "filings",
+    "go",
+    "native"
   ],
-  "dependencies": {
-    "@joplin/turndown-plugin-gfm": "^1.0.64",
-    "commander": "^14.0.1",
-    "p-limit": "^7.1.1",
-    "turndown": "^7.2.2",
-    "zod": "^4.1.5"
+  "optionalDependencies": {
+    "edgar-cli-darwin-arm64": "0.2.2",
+    "edgar-cli-linux-x64": "0.2.2"
   },
-  "devDependencies": {
-    "@types/node": "^22.13.9",
-    "@types/turndown": "^5.0.6",
-    "@typescript-eslint/eslint-plugin": "^8.44.0",
-    "@typescript-eslint/parser": "^8.44.0",
-    "eslint": "^8.57.1",
-    "nock": "^14.0.10",
-    "prettier": "^3.6.2",
-    "tsx": "^4.20.5",
-    "typescript": "^5.9.2",
-    "vitest": "^3.2.4"
+  "scripts": {
+    "build:native": "node scripts/build-native.cjs",
+    "sync:versions": "node scripts/sync-platform-versions.cjs",
+    "test:versions": "node scripts/sync-platform-versions.cjs --check",
+    "test": "npm run test:versions && node --test test/*.test.cjs"
   }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Ian Finlay
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/cli.d.ts

@@ -1,10 +0,0 @@
-#!/usr/bin/env node
-import { Command } from 'commander';
-interface CliIo {
-    stdout: (message: string) => void;
-    stderr: (message: string) => void;
-    env: NodeJS.ProcessEnv;
-}
-export declare function buildProgram(io: CliIo): Command;
-export declare function runCli(argv: string[], io?: CliIo): Promise<number>;
-export {};