Skip to content

remote.md

Latest commit

 

History

History
152 lines (104 loc) · 3.23 KB

remote.md

File metadata and controls

152 lines (104 loc) · 3.23 KB
Raw

fluree remote

Manage remote servers for syncing ledgers.

Subcommands

Subcommand Description
add Add a remote server
remove Remove a remote
list List all configured remotes
show Show details for a remote

fluree remote add

Add a remote server configuration.

Usage

fluree remote add <NAME> <URL> [OPTIONS]

Arguments

Argument Description
<NAME> Remote name (e.g., origin)
<URL> Server URL (e.g., http://localhost:8090)

Options

Option Description
--token <TOKEN> Authentication token (or @filepath to read from file)

Examples

# Add a remote without authentication
fluree remote add origin http://localhost:8090

# Add a remote with inline token
fluree remote add prod https://api.example.com --token eyJ...

# Add a remote with token from file
fluree remote add staging https://staging.example.com --token @~/.fluree/staging-token

fluree remote remove

Remove a remote configuration.

Usage

fluree remote remove <NAME>

Arguments

Argument Description
<NAME> Remote name to remove

Examples

fluree remote remove origin

fluree remote list

List all configured remotes.

Usage

fluree remote list

Output

┌─────────┬─────────────────────────────┬───────┐
│ Name    │ URL                         │ Auth  │
├─────────┼─────────────────────────────┼───────┤
│ origin  │ http://localhost:8090       │ none  │
│ prod    │ https://api.example.com     │ token │
└─────────┴─────────────────────────────┴───────┘

fluree remote show

Show detailed information about a remote.

Usage

fluree remote show <NAME>

Arguments

Argument Description
<NAME> Remote name

Output

Remote:
  Name: origin
  Type: HTTP
  URL:  http://localhost:8090
  Auth: token configured

fluree remote ledgers

List the ledgers your token can access on a remote, with the serving tiers each offers (query = the remote executes queries; blocks = raw index content is served for peer-mode local execution). Requires a bearer token with storage scope; the listing is the remote's auth-filtered catalog.

fluree remote ledgers [NAME]   # NAME defaults to the only configured remote
LEDGER            COMMIT T   INDEX T   SERVING
inventory:main    42         40        query+blocks
orders:main       17         17        query

Track one for peer-mode local querying with fluree track add <ledger> --remote <name> --mode peer (see track).

See Also

  • upstream - Configure upstream tracking
  • clone - Clone a ledger from a remote
  • fetch - Fetch refs from a remote
  • token - Create authentication tokens