Skip to content
/ cli Public

CLI tool for building and deploying custom components to the Oaysus page builder platform

Notifications You must be signed in to change notification settings

oaysus/cli

Repository files navigation

Oaysus Logo

Oaysus CLI

The visual page builder for developer-built components

Build components in React, Vue, or Svelte. Push with one command.
Let your team create pages visually.

Documentation · Watch Demo · Website

GitHub stars    npm version License: MIT

If you find Oaysus useful, please consider giving us a ⭐ on GitHub!

Oaysus CLI Demo
From code to published page in seconds


One command. Your component is live.

Watch how fast you can go from code to a published website with Oaysus.

oaysus init         # Pick your framework. Name your project.
oaysus push         # Your component builds and deploys in seconds.

No build pipelines. No complex deployments. Your marketing team creates pages visually, and you get back to building features.

Installation

npm install -g @oaysus/cli

Requires Node.js 20 or higher.

Quick Start

# 1. Authenticate with your Oaysus account
oaysus login

# 2. Create a new theme pack project
oaysus init my-components

# 3. Navigate to the project
cd my-components

# 4. Push your components to Oaysus
oaysus push

That's it. Your components are now available in the visual page builder.

✓ Validated 1 component
✓ Built and bundled (2.1 KB)
✓ Uploaded to Oaysus
✓ Published!

Install in dashboard: Content → Theme Packs

Framework Support

Build with the tools you already know:

  • React — JSX/TSX components with full hooks support
  • Vue — Single File Components (.vue)
  • Svelte — Native Svelte components (.svelte)

Framework is automatically detected from your package.json dependencies.

How Components Work

Each component has two files: the code and a schema that defines what's editable.

Component (React example):

export default function Hero({ headline, subtext, ctaLabel }) {
  return (
    <section className="py-20 text-center">
      <h1 className="text-5xl font-bold">{headline}</h1>
      <p className="mt-4 text-xl text-gray-600">{subtext}</p>
      <button className="mt-8 px-6 py-3 bg-blue-600 text-white rounded-lg">
        {ctaLabel}
      </button>
    </section>
  );
}

Schema:

{
  "displayName": "Hero Section",
  "props": {
    "headline": {
      "type": "string",
      "default": "Build faster, ship sooner"
    },
    "subtext": {
      "type": "string",
      "default": "The platform for modern teams"
    },
    "ctaLabel": {
      "type": "string",
      "default": "Get Started"
    }
  }
}

Marketing edits these props in the visual editor. You never touch the code again.

Commands

Command Description
oaysus init [name] Create a new theme pack project
oaysus create Add a component to your project
oaysus validate Validate package structure
oaysus build Build components locally (no upload)
oaysus push Build and upload to Oaysus
oaysus login Authenticate with Oaysus
oaysus logout Clear authentication
oaysus whoami Display current user

Project Structure

my-components/
├── package.json
└── components/
    ├── Hero/
    │   ├── index.tsx
    │   └── schema.json
    ├── FeatureGrid/
    │   ├── index.tsx
    │   └── schema.json
    └── Testimonials/
        ├── index.tsx
        └── schema.json

Why Oaysus?

Traditional Approach With Oaysus
Marketing files a ticket for every page change Marketing creates pages themselves
Developers build one-off landing pages Developers build reusable components
Every text change requires a deploy Changes publish instantly to global CDN
Locked into proprietary CMS themes Standard React/Vue/Svelte you own

Documentation

Get Started

  1. Create an account — Free tier available
  2. Install the CLInpm install -g @oaysus/cli
  3. Follow the quick startoaysus.com/docs/quickstart

Contributing

We welcome contributions! See CONTRIBUTING.md for development setup.

License

MIT © Oaysus

About

CLI tool for building and deploying custom components to the Oaysus page builder platform

Resources

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •