dreamina-canvas-cli-setup

Dreamina Canvas CLI Install Task

This Skill owns the installation workflow of the Dreamina Canvas CLI (official guide §1–§2): choosing the right installer for the current OS, running it under explicit authorization, verifying the result, and troubleshooting command not found. After verification it hands off to dreamina-canvas-cli-auth for login.

Install-contract detail (target directory variables, overseas build, post-install artifact checks) lives in the local Installation contract; first-use readiness and troubleshooting live in the local First use and First-use troubleshooting. Account work is handed to dreamina-canvas-cli-auth.

Operational contract

Project	Standard
Inputs and prerequisites	Operating system, shell, existing CLI path, and install/upgrade intent
Side effects	Install/update modifies the local machine; read-only checks do not trigger installation
Output handoff	Executable path, version, schema, and missing conditions
Recovery rules	If PATH has not taken effect, check the path first; do not repeatedly reinstall; hand off accounts to auth

When to use

• The user asks to install the Dreamina Canvas CLI / install dreamina-canvas on this machine.
• dreamina-canvas: command not found and PATH troubleshooting is needed.
• The user wants to update the CLI (rerunning the installer upgrades in place).
• Verifying an install: does --help show the expected command families?

When not to use

• For logging in or checking the account — that is dreamina-canvas-cli-auth.
• For using already-installed commands — the task skills or dreamina-canvas-cli.
• For deep installer internals (install-dir variables, overseas build) — the local Installation contract.

All handoffs stay inside this package; install any missing skill with npx skills add full-aigc-skills/dreamina-skills --skill <skill-name>.

Authorization first

Installation or update changes the user's machine. State the source and target directory, then obtain explicit authorization before running any installer. Never run an installer silently.

Official quick-start instruction (Guide §2 original text)

The "one-sentence instruction" the guide gives users — the entire passage can be sent directly to the user's Agent (Trae, Codex, Claude Code, etc.), and the Agent completes the installation and login process on their behalf.This is a natural-language instruction sent to the Agent, not a command to paste directly into the terminal for execution：

Please help me install the Dreamina Canvas CLI & Skill, and run the corresponding commands based on the current operating system and terminal:

• macOS / Linux: curl -fsSL https://jimeng.jianying.com/canvas-cli/install.sh | bash
• Windows PowerShell: irm https://jimeng.jianying.com/canvas-cli/install.ps1 | iex
• Windows CMD: curl.exe -fsSLO https://jimeng.jianying.com/canvas-cli/install.bat && install.bat

After installation is complete, please further read the CLI Skill and guide me through CLI availability verification and login authorization.

Standard actions after the Agent receives this instruction: install (obtain user authorization first) → --help wait for availability verification (see the table below) → hand off to dreamina-canvas-cli-auth to complete login authorization.

Installers (Official Guide §2, choose one of three by OS)

# macOS / Linux
curl -fsSL https://jimeng.jianying.com/canvas-cli/install.sh | bash

# Windows PowerShell
irm https://jimeng.jianying.com/canvas-cli/install.ps1 | iex

# Windows CMD
curl.exe -fsSLO https://jimeng.jianying.com/canvas-cli/install.bat && install.bat

• Choose exactly one installer matching the current OS and shell.
• The installer also drops the companion Skill under ~/.agents/skills/dreamina-canvas-cli/.
• Custom target directory: set DREAMINA_CANVAS_INSTALL_DIR (or the compatible INSTALL_DIR) to a user-approved path only; never silently edit shell startup files.

Success criteria (Guide §2 four steps)

Step	Command	Success criteria
Confirm available	dreamina-canvas --help	Can see commands such as auth, canvas, model, node, operation, resource
Version/contract	dreamina-canvas --format json version / schema	Returns structured version and schema
Log in	dreamina-canvas auth login	Complete authorization following the browser prompts
Self-check	dreamina-canvas auth account	Can return the current account information

Do not claim readiness from the download exit code alone — the live --help / version / schema responses are authoritative.

Troubleshooting

dreamina-canvas: command not found

1. Reopen the terminal or Agent session and try again (most common: PATH has not taken effect in the current shell).
2. Add the installation directory to PATH following the installer script's prompts.
3. Still failing → re-run the installation command.

Default installation location: macOS/Linux ~/.local/bin/dreamina-canvas；Windows Git Bash ~/bin/dreamina-canvas.exe; for custom directories, follow the installation prompts.

Before reporting an issue (required by the guide)

First update the CLI and retry (the issue may already be fixed in the new version); if it still fails, provide at once: the full command, the full error,dreamina-canvas version output, in the error result meta.requestId(if any).

Handoff

After installation verification passes:dreamina-canvas-cli-auth(login authorization and account self-check). For the post-install environment check, follow First use to gather evidence item by item.

What this Skill will not do

• Run any installer without explicit user authorization.
• Log in, refresh tokens, or run any paid command.
• Edit shell startup files silently.

Policy

Invocation requires:

• Explicit user authorization for install/update
• Current OS and shell identified

Forbids:

• Running an installer without authorization
• Logging in or running paid commands from this Skill
• Persisting OAuth tokens, cookies, signed URLs, or credentials

Default prompt:

Install only with explicit authorization; pick exactly one official installer for the OS; verify with --help/version/schema (never the download exit code alone); command-not-found is usually PATH — reopen the terminal first; then hand off to dreamina-canvas-cli-auth.

First-use check supplement environment readiness evidence; hand off account checks to dreamina-canvas-cli-auth, successful installation does not mean logged in.

Progressive disclosure (read on demand)

• When you need the installer contract, the overseas version URL, or installation directory variables, read Installation Contract。
• When you need to choose an installer by platform, troubleshoot PATH, or confirm the installation location, read Installation Guide。
• When you need a post-installation environment readiness checklist, read First Use。
• When login, PATH, or version anomalies occur during the first-use stage, read First-Use Troubleshooting。
• When you need to determine inputs/outputs, states, and authorization points, read Workflow Contract and Task Contract。
• When encountering installation failures or upgrade scenarios, read Error Recovery。
• During pre-delivery self-check, read Acceptance Checklist。

Non-Applicability and Boundaries

Not applicable to media generation, asset upload, or paid submission. When already installed and only inspection is needed, do not perform an upgrade; browser authorization and account recovery are handed off to auth.

Only read the account and asset information necessary for the current operation; do not store, log, or output access tokens, cookies, or temporary signed links.

Gotchas

• Check exit codes and structured errors; do not infer stage completion from terminal prompts.
• After user authorization is complete, report the result explicitly; on failure, retain the original error and the next step.
• Verify local availability, server-side authentication, and business permissions separately.