Documentation
¶
Overview ¶
Package cli provides the Helix project and module generator CLI tool (e.g. `helix new app`, `helix generate module`).
Index ¶
- func Build(ctx context.Context, opts BuildOptions) error
- func CreateMigration(ctx context.Context, opts CreateMigrationOptions) error
- func Generate(ctx context.Context, opts GenerateOptions) error
- func GenerateContext(ctx context.Context, opts GenerateContextOptions) error
- func GenerateModule(ctx context.Context, opts GenerateModuleOptions) error
- func GenerateWire(ctx context.Context, opts GenerateWireOptions) error
- func MigrateDown(ctx context.Context, opts MigrationOptions) error
- func MigrateUp(ctx context.Context, opts MigrationOptions) error
- func MigrationStatus(ctx context.Context, opts MigrationOptions) error
- func NewApp(ctx context.Context, opts NewAppOptions) error
- func Run(ctx context.Context, opts RunOptions) error
- type BuildOptions
- type CreateMigrationOptions
- type GenerateContextOptions
- type GenerateModuleOptions
- type GenerateOptions
- type GenerateWireOptions
- type MigrationOptions
- type NewAppOptions
- type RunOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Build ¶
func Build(ctx context.Context, opts BuildOptions) error
Build generates code and produces a static application binary.
func CreateMigration ¶
func CreateMigration(ctx context.Context, opts CreateMigrationOptions) error
CreateMigration creates a timestamped migration file.
func Generate ¶
func Generate(ctx context.Context, opts GenerateOptions) error
Generate runs Helix code generation for the configured directory tree.
func GenerateContext ¶
func GenerateContext(ctx context.Context, opts GenerateContextOptions) error
GenerateContext creates a DDD-light Helix context scaffold.
func GenerateModule ¶
func GenerateModule(ctx context.Context, opts GenerateModuleOptions) error
GenerateModule creates a conventional Helix module scaffold.
func GenerateWire ¶
func GenerateWire(ctx context.Context, opts GenerateWireOptions) error
GenerateWire runs compile-time DI wiring generation for the configured tree.
func MigrateDown ¶
func MigrateDown(ctx context.Context, opts MigrationOptions) error
MigrateDown rolls back the latest applied migration.
func MigrateUp ¶
func MigrateUp(ctx context.Context, opts MigrationOptions) error
MigrateUp applies pending migrations.
func MigrationStatus ¶
func MigrationStatus(ctx context.Context, opts MigrationOptions) error
MigrationStatus prints migration status.
Types ¶
type BuildOptions ¶
BuildOptions configures the helix build entry point.
type CreateMigrationOptions ¶
CreateMigrationOptions configures the helix db migrate create entry point.
type GenerateContextOptions ¶
GenerateContextOptions configures the helix generate context entry point.
type GenerateModuleOptions ¶
GenerateModuleOptions configures the helix generate module entry point.
type GenerateOptions ¶
type GenerateOptions struct {
Dir string
}
GenerateOptions configures the minimal helix generate entry point.
type GenerateWireOptions ¶
type GenerateWireOptions struct {
Dir string
}
GenerateWireOptions configures the helix generate wire entry point.
type MigrationOptions ¶
MigrationOptions configures helix db migrate execution entry points.
type NewAppOptions ¶
NewAppOptions configures the helix new app entry point.
type RunOptions ¶
RunOptions configures the helix run entry point.
Source Files
Directories