Utilities & Tools

ObjectUI provides a comprehensive suite of command-line tools and utilities to streamline your development workflow. These tools help you scaffold projects, create plugins, integrate with data sources, and develop with enhanced tooling support.

Quick Navigation

Browse available utilities:

Development Tools

• CLI - Project scaffolding and development server
• Create Plugin - Plugin template generator
• Runner - Universal application runtime

Data Integration

• ObjectStack Adapter - Connect to ObjectStack backend

Editor Extensions

• VS Code Extension - Schema editor and IntelliSense

Official Utilities

CLI

@object-ui/cli - Command-line interface for scaffolding and running ObjectUI applications.

• Project scaffolding from JSON schemas
• Built-in development server (Express + Vite)
• JSON/YAML schema support
• Hot module reloading

npm install -g @object-ui/cli
objectui --help

Read full documentation →

Create Plugin

@object-ui/create-plugin - Interactive CLI tool for creating ObjectUI plugins.

• Plugin template generation
• Interactive configuration prompts
• Best practices scaffolding
• TypeScript support

npm install -g @object-ui/create-plugin
create-plugin my-awesome-plugin

Read full documentation →

Runner

@object-ui/runner - Universal runtime for running ObjectUI applications.

• Standalone demo application
• Plugin testing environment
• Development playground
• Example implementations

cd packages/runner
pnpm dev

Read full documentation →

ObjectStack Adapter

@object-ui/data-objectstack - Data adapter for connecting to ObjectStack backends.

• ObjectStack client integration
• Automatic data binding
• CRUD operations support
• Query builder integration

npm install @object-ui/data-objectstack @objectstack/client

Read full documentation →

VS Code Extension

object-ui - Visual Studio Code extension for ObjectUI schema development.

• Schema preview
• JSON validation
• IntelliSense and auto-completion
• Syntax highlighting
• Export to React components
• Schema formatting

# Install from VS Code Marketplace
code --install-extension objectui.object-ui

Read full documentation →

How Utilities Work

CLI Workflow

The ObjectUI CLI provides a streamlined workflow for building applications:

# 1. Create a new project
objectui init my-app

# 2. Start the development server
cd my-app
objectui dev

# 3. Build for production
objectui build

Plugin Development Workflow

Creating plugins is simplified with the create-plugin utility:

# 1. Generate plugin scaffold
create-plugin my-plugin

# 2. Implement your component
cd my-plugin/src
# Edit index.tsx

# 3. Test your plugin
pnpm dev

# 4. Publish to npm
pnpm publish

Data Integration

Connect to ObjectStack backends with the data adapter:

import { ObjectStackProvider } from '@object-ui/data-objectstack'

function App() {
  return (
    <ObjectStackProvider
      apiUrl="https://api.example.com"
      apiKey="your-api-key"
    >
      <SchemaRenderer schema={schema} />
    </ObjectStackProvider>
  )
}

Features

All ObjectUI utilities share these characteristics:

• ✅ Easy to Use - Simple CLI interfaces
• ✅ Best Practices - Follow framework conventions
• ✅ Type-Safe - Full TypeScript support
• ✅ Well Documented - Comprehensive guides
• ✅ Actively Maintained - Regular updates

Next Steps

• CLI Documentation - Learn how to use the ObjectUI CLI
• Create Plugin Guide - Build your first plugin
• VS Code Extension - Set up your development environment
• Plugin Concepts - Learn how plugins work in detail

Need Help?

Can't find what you're looking for? Check out:

• Guide - Core concepts and guides
• Plugins - Explore available plugins
• GitHub - Report issues or contribute