Skip to content

Getting Started

The furca CLI ships today; the desktop window follows in a later release.

One line on Windows (PowerShell):

Terminal window
irm https://raw.githubusercontent.com/lacodda/furca/main/tools/install.ps1 | iex

One line on macOS / Linux:

Terminal window
curl -fsSL https://raw.githubusercontent.com/lacodda/furca/main/tools/install.sh | sh

Via cargo:

Terminal window
cargo install furca

Or download the archive for your platform from Releases (Windows x86_64, Linux x86_64, macOS arm64), unpack it and put furca on your PATH.

Variable Effect
FURCA_VERSION Install this tag (vX.Y.Z) instead of the latest release.
FURCA_INSTALL_DIR Install here instead of %LOCALAPPDATA%\Programs\furca (Windows) or ~/.local/bin (macOS, Linux).

Inside any repository:

Terminal window
$ furca status
On main at 171154d, tracking origin/main
$ furca log -n 2
171154d 2026-09-17 Ada Author docs: fill the readme out as a shopfront
d402e85 2026-09-17 Ada Author chore: point components.json at the dowel registry
... more history; raise --limit (now 2)

Every command takes --json for scripts and assistants, and -C PATH to read a repository other than the one you are in. It exits 0 when it did what was asked, 1 when the answer is no (a release plan with something in its way) and 2 when it could not answer at all. See status, refs, log and release.

The CLI is a thin door onto furca-core, a plain Rust library with no terminal or window of its own:

Terminal window
cargo add furca-core
let repo = furca_core::Repository::open(".")?;
let log = repo.log(furca_core::Tips::All, 500)?;

You need Rust; the desktop shell also needs Node 22+ and pnpm. See CONTRIBUTING.md.