mirror of
https://github.com/spacedriveapp/spacedrive.git
synced 2026-11-03 05:45:04 -05:00
Jamie Pine
bbaf0b5d54
AGENTS.md and CLAUDE.md flip their current direction from tearing down the entries world to it being gone, and drop the ephemeral note T6.7 retired. The locations page is deleted; the overview page that explained pins as location rows becomes Add Sources and Pins, and the data model, library, architecture, sync, and CLI pages describe pins as Space items. The React explorer and normalized cache guides use sources and spaces for their examples, the snapshot format doc points at the moved module, and CONTRIBUTING tracks a source instead of adding a location. The final-drop plan records FD5 with what still fails and why, the convergence plan notes the old world is gone, and the registers move FD5 to done with FDA ready.
137 lines
4.5 KiB
Plaintext
137 lines
4.5 KiB
Plaintext
---
|
|
title: Get Started with Spacedrive
|
|
description: Create a library, track your storage, and connect your devices
|
|
sidebarTitle: Get Started
|
|
---
|
|
|
|
This guide takes you from a fresh install to a searchable source. Spacedrive
|
|
runs a Rust daemon in the background. The desktop app, web interface, and CLI
|
|
are clients of that daemon, so closing a window does not stop indexing or other
|
|
durable work.
|
|
|
|
## Install Spacedrive
|
|
|
|
<Steps>
|
|
<Step>
|
|
### Download the release
|
|
|
|
Get Spacedrive 2.0 for macOS, Windows, or Linux from the
|
|
[release page](https://github.com/spacedriveapp/spacedrive/releases).
|
|
</Step>
|
|
<Step>
|
|
### Launch the app
|
|
|
|
Open Spacedrive. The app starts the local daemon and connects to it. You do not
|
|
need to create an online account.
|
|
</Step>
|
|
<Step>
|
|
### Create a library
|
|
|
|
Give the library a name such as Personal or Studio. A library holds your source
|
|
registry, organization, policies, device relationships, and small shared state.
|
|
The source stores hold the large filesystem generations.
|
|
</Step>
|
|
</Steps>
|
|
|
|
New libraries include pins for Home, Desktop, Documents, Downloads, and
|
|
Pictures. A pin is a convenient path into a source. It does not move files or
|
|
start another index.
|
|
|
|
## Track your first source
|
|
|
|
A source is a retained view of an origin. For a local filesystem source,
|
|
Spacedrive walks the chosen root, records its structure and metadata, and keeps
|
|
the store current with filesystem events.
|
|
|
|
In the app, open **Sources**, choose **Track source**, and select a folder or
|
|
mounted drive. The default capture policy skips common build artifacts and
|
|
system noise. Use an unfiltered source for archival media where every readable
|
|
name matters.
|
|
|
|
The equivalent CLI flow is:
|
|
|
|
~~~bash
|
|
sd-cli start
|
|
sd-cli library create Personal
|
|
sd-cli sources track ~/Documents
|
|
sd-cli sources list
|
|
sd-cli job list
|
|
~~~
|
|
|
|
Tracking does not relocate or rewrite your files. The source store can remain
|
|
searchable when the origin is disconnected.
|
|
|
|
<Callout type="warn">
|
|
An index proves what Spacedrive observed. It is not a second copy of file
|
|
bytes. Configure redundancy before treating any source as protected.
|
|
</Callout>
|
|
|
|
## Verify important content
|
|
|
|
Spacedrive samples file content during normal identification to keep indexing
|
|
fast. When duplicate content matters, verification reads every byte and
|
|
promotes candidate identities to confirmed integrity hashes.
|
|
|
|
~~~bash
|
|
sd-cli sources verify <SOURCE_ID>
|
|
sd-cli sources freeze <SOURCE_ID>
|
|
~~~
|
|
|
|
**verify** confirms shared content. **freeze** writes a dated, self-contained
|
|
copy of the source store. A freeze preserves what the index knew even if a
|
|
later scan changes the live generation.
|
|
|
|
## Connect another device
|
|
|
|
Pairing establishes a direct trust relationship between two Spacedrive
|
|
instances. One device generates a short code and the other joins with it:
|
|
|
|
~~~bash
|
|
sd-cli network pair generate
|
|
sd-cli network pair join "<PAIRING_CODE>"
|
|
~~~
|
|
|
|
The devices authenticate each other and connect over encrypted peer-to-peer
|
|
transport. Local discovery finds nearby devices. Internet pairing uses a relay
|
|
when a direct path is unavailable. No central Spacedrive account controls the
|
|
relationship.
|
|
|
|
After pairing, attach the remote library or its sources. You can query remote
|
|
records, stream bytes, cache selected content, and inspect jobs and logs through
|
|
the same clients you use locally.
|
|
|
|
## The four concepts to remember
|
|
|
|
| Concept | Owns |
|
|
| --- | --- |
|
|
| Library | Source registry, devices, policy, organization, and small shared state |
|
|
| Source | One origin, ingest path, portable store, and availability state |
|
|
| Pin | A folder kept in the sidebar, stored as a Space item |
|
|
| Content identity | Evidence that records contain the same bytes |
|
|
|
|
The separation matters. A removable drive can go offline without disappearing
|
|
from your library. Two pins can point into one source without duplicating
|
|
records. Two records can share a content identity without losing their distinct
|
|
paths and metadata.
|
|
|
|
## Use the same operations everywhere
|
|
|
|
The interface and CLI call the same operation registry. You can inspect the
|
|
available CLI surface with:
|
|
|
|
~~~bash
|
|
sd-cli --help
|
|
sd-cli sources --help
|
|
sd-cli op --help
|
|
~~~
|
|
|
|
**sd-cli op** exposes any registered operation with typed JSON input, which
|
|
makes the CLI a direct automation surface as well as a human tool.
|
|
|
|
## Next steps
|
|
|
|
- Learn how [sources and indexing](/core/indexing) preserve filesystem truth.
|
|
- Learn how [sources and pins](/overview/add-sources-and-pins) divide the work.
|
|
- Connect a server with the [self-hosting guide](/overview/self-hosting).
|
|
- Read about [library sync](/core/library-sync) and [file sync](/core/file-sync).
|