Package registry: @prospera/eprospera-cli on npm
TypeScript command-line interface for the e-Prospera public API.
eprospera is designed for scriptable legal-entity, application, identity, auth,
configuration, completion, and schema workflows. The CLI is JSON-friendly by
default so it can be used cleanly from shells, CI jobs, and agentic tools.
The package is published to npm as @prospera/eprospera-cli. The OpenCLI
command spec, generated API types, command implementations, completion/doc
generation scripts, validation tooling, CI, release automation, trusted
publishing, and bundled executable build are in place.
- Node.js
^22.13.0 || >=23.5.0 - pnpm 11.3.0
npm install -g @prospera/eprospera-cli
eprospera --helpFor local development:
pnpm install
pnpm run gen:all
pnpm run buildThe command surface is defined in cli.ocs.yaml.
| Area | Commands |
|---|---|
| Legal entities | entity verify, entity search, entity get, entity documents |
| Applications | application list, application create, application get, application pay, application checkout, application watch |
| Current user | me profile, me residency, me id-verification |
| Referrals | referral list |
| Visitor passes | visitor-pass create |
| Auth | auth login, auth whoami, auth logout |
| Config | config get, config set, config list, config unset |
| Shells | completion bash, completion zsh, completion fish, completion powershell |
| Schema | schema |
Common global flags:
--json
--raw
--fields id,status
--api-key <value>
--dry-run
--yesThe CLI is intended to resolve credentials in this order:
--api-key <value>EPROSPERA_API_KEY- Credentials saved by
eprospera auth login
Use eprospera --json auth whoami to confirm which credential the CLI resolved.
Add --verify to perform an API identity check where the credential type
supports one:
eprospera --json auth whoami --verifyDo not commit API keys, request payloads, .env files, or exported credentials.
The repository ignore rules are configured to keep those out of the public repo.
Useful scripts:
pnpm run gen:api # Generate TypeScript types from the public OpenAPI spec
pnpm run gen:docs # Regenerate tracked command docs under docs/commands/
pnpm run gen:completions # Generate shell completions under dist/
pnpm run validate:ocs # Validate cli.ocs.yaml against the OpenCLI schema
pnpm run typecheck # Run TypeScript without emitting files
pnpm test # Run unit tests
pnpm run test:e2e # Run opt-in staging e2e tests when EPROSPERA_E2E=1
pnpm run check # Run formatting/lint checks and typecheck
pnpm run bundle # Build a portable ncc executable at dist/bundle/
pnpm run pack:smoke # Install the packed tarball in a clean temp projectThe pre-commit hook runs pnpm run gen:all to keep generated artifacts current.
The npm package is configured to include the runtime entrypoint, compiled output, the OpenCLI spec, license, changelog, and README. It excludes source, tests, scripts, local docs, CI config, source maps, logs, and environment files.
Before publishing or tagging a release, check the package contents:
npm pack --dry-run --json --ignore-scripts
pnpm run pack:smokeBefore publishing or tagging a release, run the full local gate:
pnpm run gen:all
pnpm run check
pnpm run validate:ocs
pnpm test
pnpm run build
pnpm run bundle
npm pack --dry-run --json --ignore-scripts
pnpm run pack:smokeReleases are managed by Changesets and GitHub Actions. npm trusted publishing is
configured for repository Honduras-Prospera-inc/eprospera-cli and workflow
file release.yml, so future publishes should not require a long-lived
NPM_TOKEN secret.
If the GitHub organization blocks GITHUB_TOKEN from creating release PRs, set a
CHANGESETS_GITHUB_TOKEN repository secret with pull request and contents write
permissions. The release workflow falls back to GITHUB_TOKEN when that secret
is not present.
npm install -g @prospera/eprospera-cli
eprospera --helpThe initial 0.1.0 publish was performed manually from an authenticated npm
maintainer account, then matched with the GitHub release
@prospera/eprospera-cli@0.1.0.
MIT