Skip to content

installation.md

Latest commit

 

History

History
49 lines (31 loc) · 859 Bytes

installation.md

File metadata and controls

49 lines (31 loc) · 859 Bytes

Installation

Getting Started · Guide · Reference

Requirements

Jerd requires Node.js 16 or newer.

Install Globally

npm install --global jerd

After installation, verify the CLI is available:

jerd --help

Local Development

From the repository root:

npm install
npm run build
node dist/cli.js --help

During development you can keep TypeScript compiling in watch mode:

npm run dev

Editor Setup

Jerd opens entries in your terminal editor. It resolves the editor in this order:

  1. The EDITOR environment variable.
  2. The editor value in jerd.config.json.
  3. vim as the runtime fallback.

The generated project config currently defaults editor to nvim.

Navigation

Next: Quick Start