mirror of
https://github.com/spacedriveapp/spacedrive.git
synced 2026-04-22 23:48:26 -04:00
d7894748c1
* Updates to Landing Site - Docker Modal Sizing fixed for mobile - Matching button looks for copying across the site - Move to Next.js `v14.2.5` - Change the banner to `Alpha 0.4 is out` with a link to the release changelog. - Updates to docs for easier copy-pasting commands. * Update mobile docs in contributing * Reorganize to have welcome first Have welcome first in the list in the developers section of docs * Formatting
63 lines
1.1 KiB
Plaintext
63 lines
1.1 KiB
Plaintext
---
|
|
index: 200
|
|
---
|
|
|
|
# CLI
|
|
|
|
<Notice
|
|
type="note"
|
|
title="WIP"
|
|
text="Our CLI is not available yet, please check our [roadmap](/roadmap)."
|
|
/>
|
|
|
|
Spacedrive is available as a command-line interface (CLI) tool. The CLI is a powerful tool that allows you to interact with the Spacedrive network from your terminal.
|
|
|
|
## General Commands
|
|
|
|
### Launching Spacedrive
|
|
|
|
```bash
|
|
# Launch Spacedrive
|
|
spacedrive -d
|
|
```
|
|
|
|
```bash
|
|
# View help menu
|
|
spacedrive --help
|
|
```
|
|
|
|
```bash
|
|
# View version and build information
|
|
spacedrive --info
|
|
```
|
|
|
|
### Managing Locations
|
|
|
|
At least one identifier such as `--name`, `--path` or `--id` is required for each command.
|
|
|
|
```bash
|
|
# List all Locations
|
|
spacedrive location list
|
|
```
|
|
|
|
```bash
|
|
# Add a Location
|
|
spacedrive location add /path/to/folder --name "Location Name"
|
|
```
|
|
|
|
```bash
|
|
# Remove a Location by name
|
|
spacedrive location remove --name "Location Name"
|
|
```
|
|
|
|
```bash
|
|
# Remove a Location by path
|
|
spacedrive location remove --path /local/path/to/location
|
|
```
|
|
|
|
```bash
|
|
# Rescan a Location
|
|
spacedrive location rescan --id 4
|
|
spacedrive location rescan --id 4 --full # Full rescan
|
|
```
|