# AGENTS.md

Spacedrive is an open source cross-platform file explorer, powered by a virtual distributed filesystem written in Rust.

## Setup

```
bun install
```

## Commands

```
bun typecheck    # type check without emitting
bun preinstall
```

## Layout

- `core/`       904 source files
- `packages/`   325 source files
- `apps/`       189 source files
- `crates/`     154 source files
- `extensions/` 31 source files
- `scripts/`    18 source files

## Conventions

- Tests live alongside the code they cover, following `core/examples/fingerprint_test.rs`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/cache-factory.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/ts-client/src/generated/types.ts` is 131KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.