Documentation
¶
Index ¶
- func WriteRouteManifest(routes *router.Router, outDir string) errordeprecated
- type AICommand
- type BuildCommand
- type ControllerMethod
- type DBCreate
- type DBMigrate
- type DBRollback
- type DBSeed
- type DeployCommand
- type DeployEnvCommand
- type DeployInitCommand
- type DeployLogsCommand
- type DeployRollbackCommand
- type DeployStatusCommand
- type Field
- type ForgeBuild
- type ForgeConfig
- type ForgeHealth
- type ForgeHooks
- type ForgeResources
- type ForgeScaling
- type ForgeService
- type ForgeVolume
- type GenClientCommand
- type GeneratedFile
- type HorizonClearCommand
- type HorizonForgetCommand
- type InstallCommand
- type Intent
- type KeyGenerateCommand
- type LivewireLayout
- type MakeAPIToken
- type MakeAuth
- type MakeCommand
- type MakeController
- type MakeDeployConfig
- type MakeEvent
- type MakeFactory
- type MakeJob
- type MakeLambdaCommand
- type MakeListener
- type MakeLivewire
- type MakeMiddleware
- type MakeMigration
- type MakeModel
- type MakeNotification
- type MakeObserver
- type MakePlugin
- type MakePolicy
- type MakeResource
- type MakeRule
- type MakeSeeder
- type MakeValidator
- type MigrateFresh
- type MigrateStatus
- type NewCommand
- type PluginDef
- type PluginInstallCommand
- type PluginListCommand
- type QueueWorkCommand
- type ReleaseCommand
- type ReplCommand
- type RouteList
- type RouteManifestEntry
- type RuleManifestInfo
- type ScheduleListCommand
- type ScheduleRunCommand
- type ServeCommand
- type TestGenCommand
- type TypeScriptRuleInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WriteRouteManifest
deprecated
Types ¶
type AICommand ¶
type AICommand struct {
// contains filtered or unexported fields
}
AICommand is the `nimbus ai` CLI copilot.
func (*AICommand) Description ¶
type BuildCommand ¶
type BuildCommand struct{}
func (*BuildCommand) Args ¶
func (c *BuildCommand) Args() int
func (*BuildCommand) Description ¶
func (c *BuildCommand) Description() string
func (*BuildCommand) Name ¶
func (c *BuildCommand) Name() string
type ControllerMethod ¶
type ControllerMethod struct {
ReceiverType string // e.g., "TodoController"
Name string // e.g., "Index", "Store"
HTTPMethod string // inferred: GET, POST, PUT, DELETE
PathPattern string // inferred: /todos, /todos/:id
HasBody bool // whether it reads a body
HasParam bool // whether it reads path params
}
ControllerMethod is a parsed controller method.
type DBRollback ¶
type DBRollback struct{}
func (*DBRollback) Args ¶
func (c *DBRollback) Args() int
func (*DBRollback) Description ¶
func (c *DBRollback) Description() string
func (*DBRollback) Name ¶
func (c *DBRollback) Name() string
type DeployCommand ¶
type DeployCommand struct {
// contains filtered or unexported fields
}
DeployCommand deploys the application.
func (*DeployCommand) Aliases ¶
func (c *DeployCommand) Aliases() []string
func (*DeployCommand) Args ¶
func (c *DeployCommand) Args() int
func (*DeployCommand) Description ¶
func (c *DeployCommand) Description() string
func (*DeployCommand) Flags ¶
func (c *DeployCommand) Flags(cmd *cobra.Command)
func (*DeployCommand) Name ¶
func (c *DeployCommand) Name() string
type DeployEnvCommand ¶
type DeployEnvCommand struct {
// contains filtered or unexported fields
}
DeployEnvCommand manages env vars.
func (*DeployEnvCommand) Description ¶
func (c *DeployEnvCommand) Description() string
func (*DeployEnvCommand) Flags ¶
func (c *DeployEnvCommand) Flags(cmd *cobra.Command)
func (*DeployEnvCommand) Name ¶
func (c *DeployEnvCommand) Name() string
type DeployInitCommand ¶
type DeployInitCommand struct {
// contains filtered or unexported fields
}
DeployInitCommand initializes deployment config.
func (*DeployInitCommand) Args ¶
func (c *DeployInitCommand) Args() int
func (*DeployInitCommand) Description ¶
func (c *DeployInitCommand) Description() string
func (*DeployInitCommand) Flags ¶
func (c *DeployInitCommand) Flags(cmd *cobra.Command)
func (*DeployInitCommand) Name ¶
func (c *DeployInitCommand) Name() string
type DeployLogsCommand ¶
type DeployLogsCommand struct{}
DeployLogsCommand shows deployment logs.
func (*DeployLogsCommand) Description ¶
func (c *DeployLogsCommand) Description() string
func (*DeployLogsCommand) Name ¶
func (c *DeployLogsCommand) Name() string
type DeployRollbackCommand ¶
type DeployRollbackCommand struct{}
DeployRollbackCommand rolls back deployment.
func (*DeployRollbackCommand) Description ¶
func (c *DeployRollbackCommand) Description() string
func (*DeployRollbackCommand) Name ¶
func (c *DeployRollbackCommand) Name() string
type DeployStatusCommand ¶
type DeployStatusCommand struct{}
DeployStatusCommand checks deployment status.
func (*DeployStatusCommand) Description ¶
func (c *DeployStatusCommand) Description() string
func (*DeployStatusCommand) Name ¶
func (c *DeployStatusCommand) Name() string
type ForgeBuild ¶
type ForgeBuild struct {
Command string `json:"command"`
Output string `json:"output"`
LDFlags string `json:"ldflags"`
Tags []string `json:"tags,omitempty"`
CGOEnabled bool `json:"cgo_enabled"`
}
ForgeBuild configures the build step.
type ForgeConfig ¶
type ForgeConfig struct {
App string `json:"app"`
Target string `json:"target"`
Region string `json:"region"`
Port int `json:"port"`
GoVersion string `json:"go_version"`
Environment string `json:"environment"`
Env map[string]string `json:"env"`
Build ForgeBuild `json:"build"`
Resources ForgeResources `json:"resources"`
Health ForgeHealth `json:"health"`
Scaling ForgeScaling `json:"scaling"`
Hooks ForgeHooks `json:"hooks"`
Volumes []ForgeVolume `json:"volumes,omitempty"`
Services []ForgeService `json:"services,omitempty"`
}
ForgeConfig is the deployment configuration file (nimbus.deploy.json).
type ForgeHealth ¶
type ForgeHealth struct {
Path string `json:"path"`
Interval int `json:"interval"`
Timeout int `json:"timeout"`
}
ForgeHealth configures health checks.
type ForgeHooks ¶
type ForgeHooks struct {
PreBuild string `json:"pre_build,omitempty"`
PostBuild string `json:"post_build,omitempty"`
PreDeploy string `json:"pre_deploy,omitempty"`
Release string `json:"release,omitempty"` // DB migrations etc.
}
ForgeHooks are lifecycle hooks.
type ForgeResources ¶
type ForgeResources struct {
Memory string `json:"memory"`
CPUs int `json:"cpus"`
DiskGB int `json:"disk_gb,omitempty"`
MaxBodySize string `json:"max_body_size,omitempty"`
}
ForgeResources configures resource limits.
type ForgeScaling ¶
type ForgeScaling struct {
MinInstances int `json:"min_instances"`
MaxInstances int `json:"max_instances"`
TargetCPU int `json:"target_cpu_percent,omitempty"`
}
ForgeScaling configures auto-scaling.
type ForgeService ¶
type ForgeService struct {
Name string `json:"name"`
Type string `json:"type"` // postgres, redis, mysql
Plan string `json:"plan"`
EnvAs string `json:"env_as"` // env var to bind connection string
}
ForgeService is an additional service (DB, cache, etc.).
type ForgeVolume ¶
type ForgeVolume struct {
Name string `json:"name"`
MountPath string `json:"mount_path"`
SizeGB int `json:"size_gb"`
}
ForgeVolume configures persistent volumes.
type GenClientCommand ¶
type GenClientCommand struct {
Out string // output directory, defaults to ".nimbus-client"
}
GenClientCommand generates a type-safe TypeScript client manifest for Nimbus Hive.
func (*GenClientCommand) Args ¶
func (c *GenClientCommand) Args() int
func (*GenClientCommand) Description ¶
func (c *GenClientCommand) Description() string
func (*GenClientCommand) Name ¶
func (c *GenClientCommand) Name() string
type GeneratedFile ¶
GeneratedFile is a file to be written.
type HorizonClearCommand ¶
type HorizonClearCommand struct {
// contains filtered or unexported fields
}
func (*HorizonClearCommand) Args ¶
func (c *HorizonClearCommand) Args() int
func (*HorizonClearCommand) Description ¶
func (c *HorizonClearCommand) Description() string
func (*HorizonClearCommand) Flags ¶
func (c *HorizonClearCommand) Flags(cmd *cobra.Command)
func (*HorizonClearCommand) Name ¶
func (c *HorizonClearCommand) Name() string
type HorizonForgetCommand ¶
type HorizonForgetCommand struct {
// contains filtered or unexported fields
}
func (*HorizonForgetCommand) Args ¶
func (c *HorizonForgetCommand) Args() int
func (*HorizonForgetCommand) Description ¶
func (c *HorizonForgetCommand) Description() string
func (*HorizonForgetCommand) Flags ¶
func (c *HorizonForgetCommand) Flags(cmd *cobra.Command)
func (*HorizonForgetCommand) Name ¶
func (c *HorizonForgetCommand) Name() string
type InstallCommand ¶
type InstallCommand struct{}
func (*InstallCommand) Args ¶
func (c *InstallCommand) Args() int
func (*InstallCommand) Description ¶
func (c *InstallCommand) Description() string
func (*InstallCommand) Name ¶
func (c *InstallCommand) Name() string
type Intent ¶
type Intent struct {
Type string // "resource", "model", "controller", "migration", "middleware", "crud", "scaffold", "auth", "api", "job", "mailer", "channel"
Name string // primary entity name
Fields []Field // model fields
Hints []string // post-generation hints
Flags map[string]bool
}
Intent represents a parsed user request.
type KeyGenerateCommand ¶
type KeyGenerateCommand struct {
// contains filtered or unexported fields
}
KeyGenerateCommand generates a cryptographically strong APP_KEY and writes it into the application's .env file. This backs session encryption and HMAC token signing; the framework refuses to boot in production without a strong key (see config.Validate).
Artisan-equivalent: `php artisan key:generate`.
func (*KeyGenerateCommand) Aliases ¶
func (c *KeyGenerateCommand) Aliases() []string
func (*KeyGenerateCommand) Args ¶
func (c *KeyGenerateCommand) Args() int
func (*KeyGenerateCommand) Description ¶
func (c *KeyGenerateCommand) Description() string
func (*KeyGenerateCommand) Flags ¶
func (c *KeyGenerateCommand) Flags(cmd *cobra.Command)
func (*KeyGenerateCommand) Name ¶
func (c *KeyGenerateCommand) Name() string
type LivewireLayout ¶
type LivewireLayout struct{}
func (*LivewireLayout) Args ¶
func (c *LivewireLayout) Args() int
func (*LivewireLayout) Description ¶
func (c *LivewireLayout) Description() string
func (*LivewireLayout) Name ¶
func (c *LivewireLayout) Name() string
type MakeAPIToken ¶
type MakeAPIToken struct{}
MakeAPIToken scaffolds the personal_access_tokens migration and an example API token controller so developers can quickly add API key authentication.
func (*MakeAPIToken) Args ¶
func (c *MakeAPIToken) Args() int
func (*MakeAPIToken) Description ¶
func (c *MakeAPIToken) Description() string
func (*MakeAPIToken) Name ¶
func (c *MakeAPIToken) Name() string
type MakeCommand ¶
type MakeCommand struct{}
func (*MakeCommand) Args ¶
func (c *MakeCommand) Args() int
func (*MakeCommand) Description ¶
func (c *MakeCommand) Description() string
func (*MakeCommand) Name ¶
func (c *MakeCommand) Name() string
type MakeController ¶
type MakeController struct{}
func (*MakeController) Args ¶
func (c *MakeController) Args() int
func (*MakeController) Description ¶
func (c *MakeController) Description() string
func (*MakeController) Name ¶
func (c *MakeController) Name() string
type MakeDeployConfig ¶
type MakeDeployConfig struct{}
func (*MakeDeployConfig) Args ¶
func (c *MakeDeployConfig) Args() int
func (*MakeDeployConfig) Description ¶
func (c *MakeDeployConfig) Description() string
func (*MakeDeployConfig) Name ¶
func (c *MakeDeployConfig) Name() string
type MakeFactory ¶
type MakeFactory struct{}
func (*MakeFactory) Args ¶
func (c *MakeFactory) Args() int
func (*MakeFactory) Description ¶
func (c *MakeFactory) Description() string
func (*MakeFactory) Name ¶
func (c *MakeFactory) Name() string
type MakeLambdaCommand ¶
type MakeLambdaCommand struct{}
MakeLambdaCommand scaffolds an AWS Lambda deployment target for a Nimbus app: a cmd/lambda entry point that serves the router via the serverless adapter, a SAM template with a Function URL, and a Makefile build rule.
func (*MakeLambdaCommand) Args ¶
func (c *MakeLambdaCommand) Args() int
func (*MakeLambdaCommand) Description ¶
func (c *MakeLambdaCommand) Description() string
func (*MakeLambdaCommand) Name ¶
func (c *MakeLambdaCommand) Name() string
type MakeListener ¶
type MakeListener struct{}
func (*MakeListener) Args ¶
func (c *MakeListener) Args() int
func (*MakeListener) Description ¶
func (c *MakeListener) Description() string
func (*MakeListener) Name ¶
func (c *MakeListener) Name() string
type MakeLivewire ¶
type MakeLivewire struct{}
func (*MakeLivewire) Args ¶
func (c *MakeLivewire) Args() int
func (*MakeLivewire) Description ¶
func (c *MakeLivewire) Description() string
func (*MakeLivewire) Name ¶
func (c *MakeLivewire) Name() string
type MakeMiddleware ¶
type MakeMiddleware struct{}
func (*MakeMiddleware) Args ¶
func (c *MakeMiddleware) Args() int
func (*MakeMiddleware) Description ¶
func (c *MakeMiddleware) Description() string
func (*MakeMiddleware) Name ¶
func (c *MakeMiddleware) Name() string
type MakeMigration ¶
type MakeMigration struct {
// contains filtered or unexported fields
}
func (*MakeMigration) Args ¶
func (c *MakeMigration) Args() int
func (*MakeMigration) Description ¶
func (c *MakeMigration) Description() string
func (*MakeMigration) Flags ¶
func (c *MakeMigration) Flags(cmd *cobra.Command)
func (*MakeMigration) Name ¶
func (c *MakeMigration) Name() string
type MakeNotification ¶
type MakeNotification struct{}
func (*MakeNotification) Args ¶
func (c *MakeNotification) Args() int
func (*MakeNotification) Description ¶
func (c *MakeNotification) Description() string
func (*MakeNotification) Name ¶
func (c *MakeNotification) Name() string
type MakeObserver ¶
type MakeObserver struct{}
func (*MakeObserver) Args ¶
func (c *MakeObserver) Args() int
func (*MakeObserver) Description ¶
func (c *MakeObserver) Description() string
func (*MakeObserver) Name ¶
func (c *MakeObserver) Name() string
type MakePlugin ¶
type MakePlugin struct{}
func (*MakePlugin) Args ¶
func (c *MakePlugin) Args() int
func (*MakePlugin) Description ¶
func (c *MakePlugin) Description() string
func (*MakePlugin) Name ¶
func (c *MakePlugin) Name() string
type MakePolicy ¶
type MakePolicy struct{}
func (*MakePolicy) Args ¶
func (c *MakePolicy) Args() int
func (*MakePolicy) Description ¶
func (c *MakePolicy) Description() string
func (*MakePolicy) Name ¶
func (c *MakePolicy) Name() string
type MakeResource ¶
type MakeResource struct{}
func (*MakeResource) Args ¶
func (c *MakeResource) Args() int
func (*MakeResource) Description ¶
func (c *MakeResource) Description() string
func (*MakeResource) Name ¶
func (c *MakeResource) Name() string
type MakeSeeder ¶
type MakeSeeder struct{}
func (*MakeSeeder) Args ¶
func (c *MakeSeeder) Args() int
func (*MakeSeeder) Description ¶
func (c *MakeSeeder) Description() string
func (*MakeSeeder) Name ¶
func (c *MakeSeeder) Name() string
type MakeValidator ¶
type MakeValidator struct{}
func (*MakeValidator) Args ¶
func (c *MakeValidator) Args() int
func (*MakeValidator) Description ¶
func (c *MakeValidator) Description() string
func (*MakeValidator) Name ¶
func (c *MakeValidator) Name() string
type MigrateFresh ¶
type MigrateFresh struct{}
func (*MigrateFresh) Args ¶
func (c *MigrateFresh) Args() int
func (*MigrateFresh) Description ¶
func (c *MigrateFresh) Description() string
func (*MigrateFresh) Name ¶
func (c *MigrateFresh) Name() string
type MigrateStatus ¶
type MigrateStatus struct{}
func (*MigrateStatus) Args ¶
func (c *MigrateStatus) Args() int
func (*MigrateStatus) Description ¶
func (c *MigrateStatus) Description() string
func (*MigrateStatus) Name ¶
func (c *MigrateStatus) Name() string
type NewCommand ¶
type NewCommand struct {
// contains filtered or unexported fields
}
func (*NewCommand) Aliases ¶
func (c *NewCommand) Aliases() []string
func (*NewCommand) Args ¶
func (c *NewCommand) Args() int
func (*NewCommand) Description ¶
func (c *NewCommand) Description() string
func (*NewCommand) Flags ¶
func (c *NewCommand) Flags(cmd *cobra.Command)
func (*NewCommand) Name ¶
func (c *NewCommand) Name() string
type PluginDef ¶
type PluginDef struct {
Name string
ImportPath string
PackageName string
ImportAlias string
Description string
ServerInsert string
KernelImport string
KernelInsert string
EnvVars []string
// ConfigFiles maps relative file path → content to scaffold on install.
ConfigFiles map[string]string
// ConfigLoaderInsert is the function call (e.g. "loadTelescope()") to
// append to config/config.go's Load() function when installing the plugin.
ConfigLoaderInsert string
// ServerBootInsert is a line (e.g. "bootNoSQL(app)") inserted after the
// "bootDatabase(app)" call in bin/server.go for boot-level integrations
// that are not standard app.Use() plugins.
ServerBootInsert string
// ServerFuncInsert is a full Go function body appended to the end of
// bin/server.go (e.g. the bootNoSQL function).
ServerFuncInsert string
// ExtraImports are additional import lines when a plugin needs more than one
// package (each line must be tab-indented, include a quoted path, and end
// with \n). Skipped if that import path is already in bin/server.go.
ExtraImports []string
}
PluginDef describes how to install a plugin.
type PluginInstallCommand ¶
type PluginInstallCommand struct{}
func (*PluginInstallCommand) Args ¶
func (c *PluginInstallCommand) Args() int
func (*PluginInstallCommand) Description ¶
func (c *PluginInstallCommand) Description() string
func (*PluginInstallCommand) Name ¶
func (c *PluginInstallCommand) Name() string
type PluginListCommand ¶
type PluginListCommand struct{}
func (*PluginListCommand) Args ¶
func (c *PluginListCommand) Args() int
func (*PluginListCommand) Description ¶
func (c *PluginListCommand) Description() string
func (*PluginListCommand) Name ¶
func (c *PluginListCommand) Name() string
type QueueWorkCommand ¶
type QueueWorkCommand struct{}
func (*QueueWorkCommand) Args ¶
func (c *QueueWorkCommand) Args() int
func (*QueueWorkCommand) Description ¶
func (c *QueueWorkCommand) Description() string
func (*QueueWorkCommand) Name ¶
func (c *QueueWorkCommand) Name() string
type ReleaseCommand ¶
type ReleaseCommand struct{}
func (*ReleaseCommand) Args ¶
func (c *ReleaseCommand) Args() int
func (*ReleaseCommand) Description ¶
func (c *ReleaseCommand) Description() string
func (*ReleaseCommand) Name ¶
func (c *ReleaseCommand) Name() string
type ReplCommand ¶
type ReplCommand struct{}
func (*ReplCommand) Args ¶
func (c *ReplCommand) Args() int
func (*ReplCommand) Description ¶
func (c *ReplCommand) Description() string
func (*ReplCommand) Name ¶
func (c *ReplCommand) Name() string
type RouteManifestEntry ¶
type RouteManifestEntry struct {
Method string `json:"method"`
Path string `json:"path"`
Name string `json:"name"`
Params []string `json:"params,omitempty"`
Schema map[string]RuleManifestInfo `json:"schema,omitempty"`
}
RouteManifestEntry represents a single route in the manifest.
type RuleManifestInfo ¶
type ScheduleListCommand ¶
type ScheduleListCommand struct{}
func (*ScheduleListCommand) Args ¶
func (c *ScheduleListCommand) Args() int
func (*ScheduleListCommand) Description ¶
func (c *ScheduleListCommand) Description() string
func (*ScheduleListCommand) Name ¶
func (c *ScheduleListCommand) Name() string
type ScheduleRunCommand ¶
type ScheduleRunCommand struct{}
func (*ScheduleRunCommand) Args ¶
func (c *ScheduleRunCommand) Args() int
func (*ScheduleRunCommand) Description ¶
func (c *ScheduleRunCommand) Description() string
func (*ScheduleRunCommand) Name ¶
func (c *ScheduleRunCommand) Name() string
type ServeCommand ¶
type ServeCommand struct {
// contains filtered or unexported fields
}
func (*ServeCommand) Args ¶
func (c *ServeCommand) Args() int
func (*ServeCommand) Description ¶
func (c *ServeCommand) Description() string
func (*ServeCommand) Flags ¶
func (c *ServeCommand) Flags(cmd *cobra.Command)
func (*ServeCommand) Name ¶
func (c *ServeCommand) Name() string
type TestGenCommand ¶
type TestGenCommand struct {
// contains filtered or unexported fields
}
TestGenCommand generates tests from controllers and handlers.
func (*TestGenCommand) Aliases ¶
func (c *TestGenCommand) Aliases() []string
func (*TestGenCommand) Args ¶
func (c *TestGenCommand) Args() int
func (*TestGenCommand) Description ¶
func (c *TestGenCommand) Description() string
func (*TestGenCommand) Flags ¶
func (c *TestGenCommand) Flags(cmd *cobra.Command)
func (*TestGenCommand) Name ¶
func (c *TestGenCommand) Name() string
type TypeScriptRuleInfo ¶
TypeScriptRuleInfo describes a field's type info for code generation.
Source Files
¶
- ai.go
- build.go
- db.go
- deploy.go
- gen_client.go
- home_view_tmpl.go
- horizon.go
- inertia_home_code_snippets.go
- inertia_home_react.go
- inertia_home_svelte.go
- inertia_home_vue.go
- install.go
- key.go
- landing_css.go
- livewire.go
- make.go
- make_api_token.go
- make_auth.go
- make_deploy.go
- make_lambda.go
- misc.go
- new.go
- new_auth.go
- new_templates.go
- plugin.go
- plugin_horizon.go
- plugin_nosql.go
- plugin_reverb.go
- plugin_socialite.go
- plugin_telescope.go
- plugin_transmit.go
- release.go
- repl.go
- serve.go
- testgen.go