跳到主要內容

AFS

AFS reference

Terminology index and stable pointers to AFS operations, capabilities, errors, and related boards.

Version boundary for pointers on this page: ARC source layout as of 44fbd616f, CLI arc 2.0.0-beta.28. Paths under packages/ and providers/ refer to the ARC repository (read-only reference for site authors), not to files inside this site blocklet.

Terminology

TermMeaning
AFSPath-addressable filesystem abstraction in ARC
PathVirtual address in an instance namespace (for example /modules/project/README.md)
MountBinding from a path prefix to a provider URI/instance
Provider / AFSModuleModule that implements operations for owned paths
Capability / operations declarationWhat ops (and features) the provider claims to support
listEnumerate children; best-effort options
searchProvider-defined free-text retrieval
queryOptional strict typed collection query at /.actions/query
execInvoke an action at an executable path
explainDescribe concept or path resolution
Access modereadonly / create / append / readwrite
Visibilityfull / meta
ConformanceShared provider tests via @aigne/afs-testing
InstanceA concrete runtime with its own mounts and data

Core types and ops (source pointers)

TopicWhere in ARC
AFSModule, AFSRoot, entry/result typespackages/core/src/type.ts
Dispatcher / routingpackages/core/src/afs.ts
OperationsDeclaration, capability helperspackages/core/src/capabilities/types.ts
Collection query types + strict validatorpackages/core/src/capabilities/collection-query.ts
Error classes and codespackages/core/src/error.ts
Base provider + decoratorspackages/core/src/provider/
JSON reference providerproviders/core/json/
FS providerproviders/basic/fs/
Conformance runnerpackages/testing/ (runProviderTests)
Authoring guidedocs/guides/provider-authoring.md
Collection query guidedocs/guides/collection-query.md

CLI command group

CommandRole
arc afs lsList
arc afs readRead
arc afs writeWrite
arc afs deleteDelete
arc afs statStat
arc afs searchSearch
arc afs execExec action
arc afs explainExplain
arc afs mount …Mount management

Full flag reference: arc afs.

Board map

PageQuestion
OverviewAbstraction and non-promises
Get startedFirst command surface
Local inspectionVerified inspect walk
Core contractOps, capabilities, errors
Search and querylist vs query vs search
ProvidersProvider role
Author a providerImplementation start
Provider catalogTiered public listing
Runtime boundariesMounts, state, local vs publish
RecipesRepeatable tasks

  • AUP — declarative UI model
  • Web Device — static site provider over AFS paths
  • arc-cli — command man pages

Error codes (quick index)

See the table on Core contract. Branch on codes such as AFS_NOT_FOUND, AFS_UNSUPPORTED, AFS_VALIDATION_ERROR, AFS_CONFLICT, AFS_READONLY, AFS_AUTH_REQUIRED.