Skip to Content
DocsGetting started

Getting started

Install

Homebrew, for macOS and Linux:

brew install agent-habilis/tap/agent-share

Prebuilt binaries exist for macOS (Apple silicon and Intel) and Linux (x86-64 and ARM64). The Linux binaries need glibc 2.39 or later (Ubuntu 24.04, Debian 13).

A first share

Serve a folder

On the producer machine:

agent-share serve ./notes

The command prints the consumer command, with a ticket in it. Serve keeps running until you stop it.

Mount it

On the consumer machine, run the printed command with a target directory:

agent-share <ticket> ~/mnt

agent-share creates agent-share-YYYY-MM-DDTHHMM/ under ~/mnt and mounts the share there. The target can already hold other files.

Read it

Open the files with any tool. Bytes move only when a tool reads them. Writes fail, because the mount is read-only.

Unmount

Press Ctrl-C in the terminal that runs the mount.

On Linux, mount -t nfs usually needs sudo. If the automatic mount step fails, agent-share prints the mount command so that you can run it yourself.

No install

To read a share without the native binary, open it in the webapp, or receive it with npx agent-share <ticket>.

Platforms

Mount works on macOS (mount_nfs) and Linux (mount -t nfs). Other platforms can only serve.