Sidecrate CLI Documentation

Seller → Sidecrate CLI Documentation

Sidecrate CLI is a command-line tool for managing, submitting, and maintaining projects on the Sidecrate marketplace. It helps developers initialize projects, submit them for moderation, track status, and more.

---

Installation

To use the Sidecrate CLI, you need to download the precompiled executable file from the Seller Dashboard.

Steps:

1. Go to the Seller Dashboard.

2. Download the appropriate file for your operating system:

   • Windows: sidecrate-cli-win.exe

   • macOS: sidecrate-cli-mac

   • Linux: sidecrate-cli-linux

3. Make sure the file is executable:

   • macOS/Linux:

       chmod +x sidecrate-cli-mac
       chmod +x sidecrate-cli-linux
     

4. Run the CLI from your terminal or command prompt:

# Windows
./sidecrate-cli-win.exe [command] [options]

# macOS
./sidecrate-cli-mac [command] [options]

# Linux
./sidecrate-cli-linux [command] [options]

General Usage

sidecrate [command] [options]

Use sidecrate help to list all commands or sidecrate help <command> for detailed information.

---

Commands

init

Initialize a new Sidecrate project with a template configuration.

Options:

• -n, --name <name> — Project name

• -d, --description <description> — Project description

• -a, --author <author> — Project author

• -f, --force — Overwrite existing files

Example:

sidecrate init -n "My Project" -d "Awesome project" -a "John Doe"

---

login

Login to Sidecrate using a JWT token.

Options:

• -t, --token <token> — JWT authentication token

• -s, --session <session> — Alias for --token

Example:

sidecrate login -t <your_jwt_token>

---

validate

Validate project structure and configuration.

Options:

• -p, --path <path> — Path to project (default: current directory)

• -v, --verbose — Show detailed validation output

Example:

sidecrate validate -p ./my-project -v

---

submit

Package and submit a project to Sidecrate for moderation.

Options:

• -p, --path <path> — Project path (default: current directory)

• -t, --token <token> — JWT authentication token

• -s, --session <session> — Alias for --token

• --dry-run — Test packaging without submitting

Example:

sidecrate submit -p ./my-project --dry-run

---

status <projectId>

Check the moderation status of a submitted project.

Options:

• -t, --token <token> — JWT authentication token

• -s, --session <session> — Alias for --token

• -w, --watch — Continuously watch for status changes

Example:

sidecrate status 12345 -w

---

pause <projectId> [action]

Pause or unpause a project.

Options:

• -t, --token <token> — JWT authentication token

• -s, --session <session> — Alias for --token

Example:

sidecrate pause 12345 pause
sidecrate pause 12345 unpause

---

download <projectId>

Download a project by ID.

Options:

• -t, --token <token> — JWT authentication token

• -s, --session <session> — Alias for --token

• -o, --output <path> — Output path for downloaded project

Example:

sidecrate download 12345 -o ./downloads

---

projects

List all your projects.

Options:

• -t, --token <token> — JWT authentication token

• -s, --session <session> — Alias for --token

• -l, --limit <number> — Limit number of projects to retrieve

• -o, --offset <number> — Offset for pagination

• --status <status> — Filter by project status (active, sold, in_review, rejected, paused)

Example:

sidecrate projects --status active --limit 10

---

generate-readme

Generate README.md based on project configuration.

Options:

• -p, --path <path> — Project path (default: current directory)

• -f, --force — Overwrite existing README.md

Example:

sidecrate generate-readme -p ./my-project -f

---

check-deps

Check project dependencies for security and license issues.

Options:

• -p, --path <path> — Project path (default: current directory)

• --fix — Attempt to fix issues automatically

Example:

sidecrate check-deps -p ./my-project --fix

---

help [command]

Display help information for all commands or a specific command.

Example:

sidecrate help
sidecrate help submit