mirror of
https://github.com/shumaiOne/shumai.git
synced 2026-11-22 15:57:14 +00:00
101 lines
2.5 KiB
Markdown
101 lines
2.5 KiB
Markdown
# Shumai CLI
|
|
|
|
A Command Line Interface (CLI) tool for interacting with your Shumai instance.
|
|
|
|
The CLI allows you to view projects, list folder contents, create folders, upload files and directories, and create new versions of existing files directly from the terminal.
|
|
|
|
---
|
|
|
|
## Installation
|
|
|
|
The CLI package is bundled inside the Shumai workspace.
|
|
|
|
### Environment Setup
|
|
|
|
Before using the CLI, you must set the following environment variables to authenticate with your Shumai instance:
|
|
|
|
```bash
|
|
# The endpoint of your Shumai API server (e.g. http://localhost:3000)
|
|
export SHUMAI_API_SERVER="http://localhost:3000"
|
|
|
|
# Your personal API Token (Generate this in the WebUI via Settings -> Developer tab)
|
|
export SHUMAI_API_KEY="your-developer-api-token"
|
|
```
|
|
|
|
---
|
|
|
|
## Usage
|
|
|
|
> [!IMPORTANT]
|
|
> **For Bun Users:** Since the package binary contains a `#!/usr/bin/env node` shebang, running `shumai-cli` directly will run under Node.js. If you wish to run it using Bun, prefix the command with `bun run --bun` (e.g., `bun run --bun shumai-cli project ls`).
|
|
|
|
Run `shumai-cli` or query specific commands:
|
|
|
|
```bash
|
|
shumai-cli <command> [arguments] [options]
|
|
```
|
|
|
|
### Commands
|
|
|
|
#### 1. List Projects
|
|
|
|
List all projects you have access to. Returns the project ID, name, and its root folder ID.
|
|
|
|
```bash
|
|
shumai-cli project ls
|
|
```
|
|
|
|
#### 2. List Directory Contents
|
|
|
|
List direct children (folders and files) of a parent folder.
|
|
|
|
```bash
|
|
shumai-cli ls -p <parentId>
|
|
```
|
|
|
|
- **Options:**
|
|
- `-p`, `--parent <id>`: The parent folder ID (required).
|
|
|
|
#### 3. Create a New Folder
|
|
|
|
Create a new folder under a parent folder.
|
|
|
|
```bash
|
|
shumai-cli mkdir <name> -p <parentId>
|
|
```
|
|
|
|
- **Options:**
|
|
- `-p`, `--parent <id>`: The parent folder ID (required).
|
|
|
|
#### 4. Upload Files or Folders
|
|
|
|
Upload a local file or folder to a target parent folder. File sizes and paths are mapped, and uploads are streamed chunk-by-chunk with a progress bar.
|
|
|
|
```bash
|
|
shumai-cli upload <localPath> -p <parentId>
|
|
```
|
|
|
|
- **Options:**
|
|
- `-p`, `--parent <id>`: The parent folder ID (required).
|
|
|
|
#### 5. Create a New Version of a File
|
|
|
|
Upload a local file as a new version of an existing asset (which must be a file or a version stack). This wraps the assets into a version stack dynamically on the server.
|
|
|
|
```bash
|
|
shumai-cli create-version <localFilePath> -p <parentAssetId>
|
|
```
|
|
|
|
- **Options:**
|
|
- `-p`, `--parent <id>`: The parent asset ID (file or version stack) to version (required).
|
|
|
|
---
|
|
|
|
## Development
|
|
|
|
To run the CLI in development mode inside the repository source code:
|
|
|
|
```bash
|
|
bun run apps/cli/src/index.ts project ls
|
|
```
|