@fincore/cli
v0.1.1
Published
CLI for Fin-Core hosted tenant APIs and Hello World onboarding.
Downloads
233
Readme
@fincore/cli
CLI for tenant-facing Fin-Core operations and hosted Hello World onboarding.
Install
Run without a global install:
npx @fincore/cli doctorInstall globally:
npm install -g @fincore/cli
fincore doctorInstall into a local project:
npm install @fincore/cli
npx fincore doctorDistribution note:
- The intended public install paths are npm global install and
npx. - Phase 20 CI validates the same publish-shaped artifact path before the first registry release.
Windows / offline zip bundle
For restricted environments, a secondary .zip bundle can be assembled from the built CLI.
Validated offline path:
- unzip
fincore-cli-<version>-offline.zip - set
FINCORE_BASE_URLandFINCORE_API_KEY - run
node .\dist\index.js doctor - run
node .\dist\index.js hello - run
node .\dist\index.js usage
PowerShell helper:
$env:FINCORE_BASE_URL = "https://YOUR_FINCORE_BASE_URL"
$env:FINCORE_API_KEY = "YOUR_API_KEY"
.\samples\doctor-hello-usage.ps1Notes:
- the CLI zip bundles the same built
@fincore/sdkundernode_modules/@fincore/sdk - it is a manual Node execution path, not a native Windows executable
- see
docs/public/windows-offline-quickstart.mdfor the tested Windows flow
Commands:
fincore whoamifincore quickstartfincore hellofincore doctorfincore planfincore healthfincore usage [--view <summary|metering>]fincore chains listfincore suites listfincore deployments listfincore deployments show --deployment-id <id>fincore official-rail showfincore api-keys listfincore api-keys create --label <label> [--environment <env>] [--expires-at <iso>]fincore api-keys rotate <keyId> [--label <label>] [--environment <env>] [--expires-at <iso>]fincore api-keys revoke <keyId>
Discovery command visibility rules:
- official contract-platform rows are visible to all authenticated tenants
- tenant custom suites/deployments are only visible to the tenant that owns them
- commands are read-only and do not enable contract mutation or custom authoring
Configuration precedence:
FINCORE_API_KEY/FINCORE_BASE_URL~/.fincore/configJSON
First hosted flow:
fincore doctorfincore hellofincore usage- open
/usage
fincore doctor checks:
- API key validity
- tenant hosted state
- plan/tier visibility
- connectivity
- request-time rate-limit posture
fincore quickstart is optional orientation, not part of the formal hosted success contract.
Exit codes:
0ok2usage/config missing10unauthorized (401)11forbidden (403)13suspended/revoked tenant14pending tenant activation15entitlement denied12not found (404)20rate limited (429)30upstream 5xx40network-ish70unknown
