Async Local Configuration

Configuration for async local filesystem.

Async Local Configuration (YAML)
1
2
3
4
- type: asynclocal
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  auto_mkdir: false  # Automatically create parent directories on write

BaseModel Configuration

Configuration for Pydantic BaseModel schema filesystem.

BaseModel Configuration (YAML)
1
2
3
4
- type: basemodel
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  model: mypackage.MyModel  # BaseModel class import path

BaseModel Instance Configuration

Configuration for Pydantic BaseModel instance filesystem.

BaseModel Instance Configuration (YAML)
1
2
3
4
- type: basemodel_instance
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  instance: mypackage.model_instance  # BaseModel instance import path

CLI Configuration

Configuration for CLI filesystem.

CLI Configuration (YAML)
1
2
3
4
5
- type: cli
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  shell: false  # Whether to use shell mode for command execution
  encoding: utf-8  # Output encoding for command results

Distribution Configuration

Configuration for Distribution filesystem.

Distribution Configuration (YAML)
1
2
3
- type: distribution
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.

Flat Union Configuration

Configuration for FlatUnion filesystem.

Flat Union Configuration (YAML)
1
2
3
4
5
6
7
- type: flatunion
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  filesystems:  # List of filesystem identifiers to include in the union
  - fs1
  - fs2
  - fs3

HTTP Configuration

Configuration for HTTP filesystem.

HTTP Configuration (YAML)
1
2
3
4
5
6
7
8
9
- type: http
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  simple_links: true  # Whether to extract links using simpler regex patterns
  block_size: null  # Block size for reading files in chunks
  same_scheme: true  # Whether to keep the same scheme (http/https) when following links
  size_policy: null  # Policy for determining file size ('head' or 'get')
  cache_type: bytes  # Type of cache to use for file contents
  encoded: false  # Whether URLs are already encoded

HTTPX Configuration

Configuration for HTTPX-based HTTP filesystem.

HTTPX Configuration (YAML)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- type: httpx
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  simple_links: true  # Whether to extract links using simpler regex patterns
  block_size: null  # Block size for reading files in chunks
  same_scheme: true  # Whether to keep the same scheme (http/https) when following links
  size_policy: null  # Policy for determining file size ('head' or 'get')
  cache_type: bytes  # Type of cache to use for file contents
  encoded: false  # Whether URLs are already encoded
  timeout: null  # HTTP request timeout in seconds

Overlay Configuration

Configuration for overlay filesystem with copy-on-write semantics.

Overlay Configuration (YAML)
1
2
3
4
5
6
- type: overlay
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  filesystems:  # List of filesystem identifiers, first is writable upper layer
  - writable_fs
  - readonly_fs

Package Configuration

Configuration for Package filesystem.

Package Configuration (YAML)
1
2
3
4
- type: pkg
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  package: upathtools  # Name of the package to browse

Skills Configuration

Configuration for Skills filesystem.

Skills Configuration (YAML)
1
2
3
4
- type: skills
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  skills_dir: null  # Directory containing skill definitions

Union Configuration

Configuration for Union filesystem.

Union Configuration (YAML)
1
2
3
4
5
- type: union
  root_path: null  # Root directory to restrict filesystem access to (wraps in DirFileSystem).
  cached: false  # Whether to wrap in CachingFileSystem.
  filesystems:  # Dictionary mapping protocol names to filesystem configurations
    example_name: a