@activefs/cli

Embeddable implementation package for the ActiveFS CLI and TUI.

Most users should install the activefs package for the activefs command. Use @activefs/cli when you want to call the CLI implementation from tests, tools, or another Node.js program.

Install

npm install @activefs/cli

Requires Node.js 20 or newer.

Small Example

import { main } from "@activefs/cli";

const stateRoot = ".activefs";

await main(["remote", "add", "repo", "--demo", "--port", "3999", "--state-root", stateRoot]);
try {
  await main(["list", "/repo", "--state-root", stateRoot]);
  await main(["read", "/repo/README.txt", "--state-root", stateRoot]);
  await main(["grep", "Source", "/repo", "--json", "--state-root", stateRoot]);
} finally {
  await main(["remote", "remove", "repo", "--force", "--state-root", stateRoot]);
}

User-Facing Binary

npm install -g activefs
activefs --help

The activefs package provides the command-line binary. This package provides the implementation behind it.

What It Owns

• CLI command parsing and command handlers.
• Remote, auth, status, server, MCP, export, cache, sync, mount, direct access, and troubleshooting workflows.
• TUI runtime integration.
• Test injection hooks for host-sensitive mount and daemon behavior.

Docs

• CLI: https://github.com/ankitparasher/activefs/blob/main/docs/reference/cli.md
• Quickstart: https://github.com/ankitparasher/activefs/blob/main/docs/quickstart.md
• MCP: https://github.com/ankitparasher/activefs/blob/main/docs/guides/mcp.md