Skip to main content

Quickstart

This quickstart assumes:

  • You have the aether binary installed.
  • You know the service endpoint you should connect to.
  • You have access to a session you are allowed to mount.
  • You have whatever authentication material your deployment requires.

1. Set the service endpoint and auth context​

Make the remote endpoint and auth context explicit before you try to mount.

Common environment pattern:

export AFS_AETHER_SERVER_ENDPOINT='https://grpc.aetherfs.io'
export AFS_AUTH_TOKEN='Bearer <tenant-uuid>:<principal>'

Or through config for the endpoint:

[bridge]
server_endpoint = "https://grpc.aetherfs.io"

You can also pass auth via --auth-token-file or --auth-token-stdin instead of AFS_AUTH_TOKEN.

AFS_AETHER_SERVER_ENDPOINT and [bridge].server_endpoint are the main entry points for telling the CLI where to connect.

2. Create or identify a session​

You need a session identifier before you can mount.

How you obtain that session depends on your product workflow:

  • A web app or automation flow may create it for you.
  • You may create it through the HTTP API.
  • Another user or system may hand off an existing session ID.

3. Run local preflight checks and prepare the mount path​

aether doctor checks local prerequisites such as FUSE availability, kernel capabilities, and the configured mount directory when mount_dir is already set in config.

aether doctor
mkdir -p ./workdir

doctor does not validate remote reachability, auth, or session access. The real end-to-end test for those is aether mount.

4. Mount the session locally​

Mount the session to a directory you control:

aether mount --session-id '<session-id>' --mount-dir ./workdir

Exact flags may vary by version, so check:

aether mount --help

Once mounted, local tools can work against the mounted path.

5. Verify the running client locally​

Useful follow-up commands include:

aether status --session-id '<session-id>'
aether metrics show

Use aether status to inspect the running local runtime after Aether CLI is active.

Use aether metrics show to print the resolved metrics endpoint and scrape URL.

6. Stop or unmount when finished​

When you are done with the local session workflow, stop the local runtime or unmount using the commands appropriate for your platform and current aether version:

aether stop --session-id '<session-id>'

Also see platform-specific unmount behavior in Mounts.

Next steps​