Skip to content

Installation

nexus-fs requires Python 3.11+.

Base install

The base package includes the local filesystem backend:

pip install nexus-fs

Extras

Add cloud backends by installing extras:

pip install nexus-fs[s3]

Installs boto3. Requires AWS credentials — see S3 setup.

pip install nexus-fs[gcs]

Installs google-cloud-storage. Requires Application Default Credentials — see GCS setup.

pip install nexus-fs[gdrive]

Installs google-api-python-client and google-auth-oauthlib. Requires OAuth setup — see Google Drive setup.

pip install nexus-fs[all]

Installs all backends plus the interactive TUI (textual).

Optional: fsspec integration

To use nexus-fs as an fsspec filesystem (for pandas, dask, HuggingFace):

pip install nexus-fs[fsspec]

See fsspec integration for usage.

Optional: interactive TUI

The playground command requires the TUI extra:

pip install nexus-fs[tui]

See nexus-fs playground for details.

Verify

nexus-fs doctor

This checks your Python version, installed backends, and credential configuration. See nexus-fs doctor for interpreting the output.