Installation
curl -fsSL https://raw.githubusercontent.com/StacDev/install/main/install.sh | bash
irm https://raw.githubusercontent.com/StacDev/install/main/install.ps1 | iex
Available Commands
| Command | Description | Requires Auth |
|---|
login | Authenticate with Google OAuth | No |
logout | Clear stored authentication tokens | No |
status | Show authentication status | No |
init | Initialize Stac in project | Yes |
build | Convert Dart widgets to JSON | No |
deploy | Build and deploy to Stac Cloud | Yes |
project list | List all cloud projects | Yes |
project create | Create new cloud project | Yes |
Authentication
Before using most CLI commands, you’ll need to authenticate with Stac Cloud.
Login
This opens your browser for OAuth authentication. Your credentials are securely stored locally.
Check Status
Logout
Initialize Stac
Use this to set up Stac in an existing Flutter/Dart project. It links your local app to a Stac Cloud project and scaffolds required files.
What it does
- Creates
stac/ folder for Stac DSL widgets
- Adds
lib/default_stac_options.dart with your StacOptions (e.g., projectId)
- Updates
pubspec.yaml with stac and related dependencies
- Optionally links to an existing Stac Cloud project
Generated files
|- Flutter project
├── lib/
│ ├── default_stac_options.dart
│ └── main.dart
├── stac/
│ └── stac_widget.dart
└── pubspec.yaml
Convert Dart to JSON
Build all widgets in current project:
Build specific project directory:
stac build --project /path/to/project
Build Options
| Option | Description | Default |
|---|
-p, --project | Project directory path | Current directory |
--validate | Validate generated JSON | true |
-v, --verbose | Show detailed build output | false |
stac/ folder into JSON format in the build/ folder.
Deploy to Stac Cloud
Build and deploy to Stac Cloud:
Deploy specific project directory:
stac deploy --project /path/to/project
Deployment Options
| Option | Description | Default |
|---|
-p, --project | Project directory path | Current directory |
--skip-build | Skip building before deployment | false |
-v, --verbose | Show detailed deployment output | false |
By default, stac deploy automatically runs stac build before deploying. Use --skip-build to deploy existing build files without rebuilding.
List Projects
List all your Stac Cloud projects:
Output as JSON format:
The list command shows:
- Project name and ID
- Project description
- Created and updated timestamps
Create New Project
stac project create --name "My App" --description "My SDUI app"
stac project create -n "My App" -d "My SDUI app"
stac init to initialize it locally.
Typical Workflow
- Authenticate with Stac Cloud (one-time):
- List available projects:
- Initialize a project in your Flutter/Dart app:
cd your-flutter-project
stac init
- Create your widget definitions in the
stac/ folder, then deploy:
Command Reference
Global Options
| Option | Description |
|---|
-v, --verbose | Show additional command output |
--version | Print tool version |
--help | Print usage information |
