CLI Reference

Command Reference

Complete reference for all Oaysus CLI commands. Build theme packs with reusable components, manage website projects with local page files, and sync everything with a single command. New here? Start with the Quick Start guide.

Theme Pack Commands

oaysus theme init
Create a new theme pack project
oaysus theme create
Add a component to existing project
oaysus theme validate
Check package for errors
oaysus theme build
Build components locally
oaysus theme pushauth
Build and upload to Oaysus
oaysus theme deleteauth
Delete a theme pack

Website Commands

oaysus site init
Create a new website project
oaysus site validate
Validate pages against components
oaysus site publishauth
Publish pages to your website
oaysus site pullauth
Download pages from server

Global Commands

oaysus login
Authenticate with Oaysus
oaysus switchauth
Switch between your websites
oaysus logout
Clear stored credentials
oaysus whoami
Show current user and session
oaysus telemetry
Manage usage analytics

Why Use the CLI?

The Oaysus CLI transforms how developers and marketing teams collaborate. Instead of the traditional ticket-based workflow where marketing waits on engineering for every content change, the CLI enables a true separation of concerns.

Theme Packs for Developers

Build components once with editable prop schemas. Push them to Oaysus and never touch them again unless you need to add new features. Marketing edits content; you build the system.

Site Projects for Power Users

Store page configurations as JSON files in your repository. Version control your marketing pages. Review changes in pull requests. Deploy with confidence.

The Speed Advantage

With site pull and site publish, you can:

  • Pull all page configurations from the dashboard to local JSON files
  • Edit multiple pages at once using your favorite code editor or AI tools
  • Publish all changes back to the server in a single command

Theme Pack Commands

Website Commands

Global Commands

Supercharge with AI

The site pull and site publish commands unlock a powerful workflow when combined with AI coding assistants. Your pages become JSON files that any LLM can read and modify.

The AI-Powered Workflow

  1. 1Run oaysus site pull to download all pages as JSON files
  2. 2Ask your AI assistant: "Update all hero sections to use our new brand colors" or "Add a CTA button to every page"
  3. 3The AI modifies multiple JSON files in seconds, something that would take hours in a visual editor
  4. 4Review the changes in your diff tool or just run oaysus site validate
  5. 5Run oaysus site publish to push all changes live

Example Prompts

  • "Update all testimonial sections with these new customer quotes"
  • "Change the pricing on all pages from $99 to $149"
  • "Add a newsletter signup form to every page footer"
  • "Translate all page content to Spanish"

Time Savings

  • Manual: 30+ minutes editing each page individually in the UI
  • With AI: 2 minutes to pull, prompt, and publish
  • Bonus: Changes are reviewable in version control before going live

Project Structures

Theme Pack Project

Created by oaysus theme init:

my-components/
├── components/
│   └── Hero/
│       ├── index.tsx
│       └── schema.json
├── shared/
├── package.json
└── README.md

Website Project

Created by oaysus site init:

my-marketing-site/
├── pages/
│   ├── home.json
│   ├── about.json
│   ├── pricing.json
│   └── blog/
│       └── index.json
├── assets/
│   └── images/
├── components.json
└── oaysus.config.json
pages/JSON files representing each page and its component configuration
assets/Images and files referenced by your pages
components.jsonCatalog of available components from installed theme packs
oaysus.config.jsonProject configuration including website ID and settings

Troubleshooting

"Command not found: oaysus"

Reinstall with npm install -g @oaysus/cli or ensure npm global bin is in your PATH.

"Not authenticated" on push/publish

Run oaysus login to authenticate. Use oaysus whoami to check token expiry.

"Invalid theme pack structure"

Ensure your project has both package.json and components/ directory. Run oaysus theme validate for details.

"Component not found" on site validate

Run oaysus site pull to sync the component catalog. Ensure the theme pack containing the component is installed in your dashboard.

"Schema validation failed"

Check that each component has a valid schema.json with correct JSON syntax. See schema reference for required fields.

Continue to Building Components