Skip to content

README.md

Latest commit

 

History

History
108 lines (68 loc) · 1.45 KB

README.md

File metadata and controls

108 lines (68 loc) · 1.45 KB

GitLedger CLI

GitLedger CLI is the command line interface for GitLedger workflows.

It provides a developer friendly wrapper for backend checks, local config inspection, and future staking and review automation commands.

Status

This repository is scaffolded as an open source TypeScript CLI foundation.

Requirements

  • Node.js 18+

Install

npm install

Run in development

npm run dev -- --help

Build

npm run build

Usage

Show help

gitledger --help

Check backend health

npm run dev -- health

Override backend URL:

npm run dev -- health --api-url https://backend-uuq8.onrender.com

Machine-readable health output:

npm run dev -- health --json

Config commands

Initialize local config file (~/.gitledger/config.json):

npm run dev -- config:init

Show effective config:

npm run dev -- config:show

Set backend URL in config:

npm run dev -- config:set backendUrl https://backend-uuq8.onrender.com

Read a config key:

npm run dev -- config:get backendUrl

Run diagnostics (config + backend health):

npm run dev -- doctor

Project layout

  • src/index.ts CLI entrypoint
  • src/commands/ command handlers
  • src/config/ local config store logic
  • src/lib/ shared output and utility helpers

Contributing

See CONTRIBUTING.md.

Security

See SECURITY.md.

License

MIT