@oaysus/cli
v0.1.17
Published
Build React, Vue, or Svelte components and push them to a visual page builder. Empower marketing teams to create pages without code.
Maintainers
Readme
One command. Your component is live.
Watch how fast you can go from code to a published website with Oaysus.
oaysus theme init # Pick your framework. Name your project.
oaysus theme 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/cliRequires Node.js 20 or higher.
Quick Start
# 1. Authenticate with your Oaysus account
oaysus login
# 2. Create a new theme pack project
oaysus theme init my-components
# 3. Navigate to the project
cd my-components
# 4. Push your components to Oaysus
oaysus theme pushThat'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 PacksFramework 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
Theme Pack Commands
Build and manage reusable component libraries.
| Command | Description |
|---------|-------------|
| oaysus theme init | Create a new theme pack project |
| oaysus theme create | Add a component to your theme pack |
| oaysus theme validate | Validate theme pack structure |
| oaysus theme push | Build and upload to Oaysus |
| oaysus theme delete | Delete a theme pack from Oaysus |
Site Commands
Manage website pages and content.
| Command | Description |
|---------|-------------|
| oaysus site init | Create a new website project |
| oaysus site validate | Validate pages against installed components |
| oaysus site publish | Publish pages to your website |
| oaysus site pull | Download pages from server to local files |
Global Commands
Authentication and account management.
| Command | Description |
|---------|-------------|
| oaysus login | Authenticate with your Oaysus account |
| oaysus whoami | Display current user information |
| oaysus switch | Switch between your websites |
| oaysus logout | Clear authentication tokens |
Telemetry Commands
Manage anonymous usage analytics.
| Command | Description |
|---------|-------------|
| oaysus telemetry status | Show current telemetry status |
| oaysus telemetry enable | Enable anonymous usage tracking |
| oaysus telemetry disable | Disable anonymous usage tracking |
Oaysus CLI collects anonymous usage data to help improve the tool. No personal data, file contents, or source code is collected. You can also disable telemetry via the OAYSUS_TELEMETRY_DISABLED=1 environment variable.
Project Structure
my-components/
├── package.json
└── components/
├── Hero/
│ ├── index.tsx
│ └── schema.json
├── FeatureGrid/
│ ├── index.tsx
│ └── schema.json
└── Testimonials/
├── index.tsx
└── schema.jsonWhy 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
- Quick Start Guide — Build your first component in 5 minutes
- CLI Reference — Complete command documentation
- Component Guide — Props, schemas, and best practices
- Theme Packs — Organize and distribute component collections
Get Started
- Create an account — Free tier available
- Install the CLI —
npm install -g @oaysus/cli - Follow the quick start — oaysus.com/docs/quickstart
Contributing
We welcome contributions! See CONTRIBUTING.md for development setup.
License
MIT © Oaysus
