Installation

Get Janee running on your machine.

Requirements

  • Node.js 18+ — Janee is built on Node.js
  • npm, yarn, or pnpm — any package manager works

Global Install (recommended)

npm install -g @true-and-useful/janee

This gives you the janee CLI globally:

janee --version
janee --help

npx (no install)

Run without installing:

npx @true-and-useful/janee init
npx @true-and-useful/janee serve

From Source

git clone https://github.com/rsdouglas/janee.git
cd janee
npm install
npm run build
npm link

Initialize

After installation, initialize your config:

janee init

This creates ~/.janee/config.yaml with example services. Edit it to add your API keys.

Verify Installation

janee serve --help

You should see the serve command options. Next, follow the quickstart to configure your first provider.

Updating

npm update -g @true-and-useful/janee
← Quickstart Providers →