Reference
CLI Commands
Complete GhostFS command reference
CLI Commands
server
Start the RPC server.
ghostfs server [options]| Option | Description | Default |
|---|---|---|
--root, -r | Root directory to serve | ~/.ghostfs/root |
--bind, -b | Address to bind | 127.0.0.1 |
--port, -p | Port to listen on | 3444 |
--key, -k | TLS private key file | — |
--cert, -T | TLS certificate file | — |
--acme | Enable Let's Encrypt auto TLS | false |
--acme-domain | Domain name for certificate | — |
--acme-email | Email for Let's Encrypt | — |
--web | Also start HTTP web server | false |
--http-port | HTTP port for web UI | 8080 |
--http-static | Static files directory | — |
web
Start a standalone HTTP web server for browser-based file management.
ghostfs web [options]| Option | Description | Default |
|---|---|---|
--root, -r | Root directory to serve | ~/.ghostfs/root |
--bind, -b | Address to bind | 127.0.0.1 |
--http-port | HTTP port | 8080 |
--http-static | Static files directory | — |
--key, -k | TLS private key file | — |
--cert, -T | TLS certificate file | — |
--acme | Enable Let's Encrypt auto TLS | false |
--acme-domain | Domain name for certificate | — |
--acme-email | Email for Let's Encrypt | — |
mount
Mount a remote filesystem.
ghostfs mount <mountpoint> [options]| Option | Description | Default |
|---|---|---|
--host, -H | Server hostname | 127.0.0.1 |
--port, -p | Server port | 3444 |
--user, -u | Username | — |
--token, -t | Authentication token | — |
--encrypt, -e | Enable encryption | false |
--encryption-key | Path to encryption key | — |
--write-back, -w | Write cache size | 64 |
--read-ahead, -C | Read-ahead blocks | 8 |
--key, -k | TLS private key | — |
--cert, -T | TLS certificate | — |
auth
Manage authentication tokens.
ghostfs auth <subcommand> [options]auth add
ghostfs auth add --user <username> [--token <token>]auth list
ghostfs auth listauth revoke
ghostfs auth revoke --token <token>share
Manage file sharing.
ghostfs share <subcommand> [options]share create
ghostfs share create --path <path> --name <name>share list
ghostfs share list [--owned] [--received]share add-recipient
ghostfs share add-recipient --id <share-id> --user <username>share mount
ghostfs share mount --id <share-id> --mount-path <path>share revoke
ghostfs share revoke --id <share-id>admin
Administrative commands.
ghostfs admin <subcommand> [options]admin generate-key
ghostfs admin generate-key <output-path>cp
Copy files between local and remote.
ghostfs cp <source> <destination> [options]| Option | Description |
|---|---|
--host, -H | Server hostname |
--user, -u | Username |
--token, -t | Token |