@famgia/omnify-bin
v0.1.0
Published
Schema-driven code generation for Laravel, TypeScript, and SQL
Readme
@famgia/omnify-bin
Schema-driven code generation for Laravel, TypeScript, and SQL. Define your database schemas in YAML once, then generate migrations, models, interfaces, and more.
Installation
# Global install
npm install -g @famgia/omnify-bin
# Or use npx
npx @famgia/omnify-bin generateQuick Start
# Initialize a new project
omnify init
# Define schemas in schemas/ directory, then generate
omnify generate
# Validate your schemas
omnify validate
# Show what changed since last generation
omnify diff
# Start MCP server for AI assistant integration
omnify mcpSchema Example
# schemas/User.yaml
name: User
kind: object
displayName:
en: User
ja: ユーザー
options:
timestamps: true
softDelete: true
properties:
name:
type: String
length: 100
required: true
displayName:
en: Name
ja: 名前
email:
type: String
length: 255
required: true
unique: true
displayName:
en: Email
ja: メールアドレス
role:
type: Enum
enum: [admin, editor, viewer]
default: viewer
displayName:
en: Role
ja: 役割Configuration
Create omnify.yaml in your project root:
schemasDir: schemas
generators:
laravel:
enabled: true
migrationsDir: database/migrations
modelsDir: app/Models
sql:
enabled: true
outputDir: migrations
dialect: mysqlMCP Integration
omnify includes a built-in MCP (Model Context Protocol) server for AI assistants:
{
"mcpServers": {
"omnify": {
"command": "omnify",
"args": ["mcp"]
}
}
}If installed via npm:
{
"mcpServers": {
"omnify": {
"command": "npx",
"args": ["@famgia/omnify-bin", "mcp"]
}
}
}Supported Platforms
| Platform | Architecture | Package |
|----------|-------------|---------|
| macOS | Apple Silicon (arm64) | @famgia/omnify-bin-darwin-arm64 |
| macOS | Intel (x64) | @famgia/omnify-bin-darwin-x64 |
| Linux | x86_64 | @famgia/omnify-bin-linux-x64 |
| Linux | ARM64 | @famgia/omnify-bin-linux-arm64 |
| Windows | x86_64 | @famgia/omnify-bin-win32-x64 |
The correct platform package is installed automatically via optionalDependencies.
License
MIT
