README
¶
Ox
Ox is a CLI for the Go Buffalo web development ecosystem. The Ox binary provides base commands for Buffalo development operations and allows teams to plug their tools into the development workflow.
Installation
To install Ox, run:
go install github.com/wawandco/ox/cmd/ox@latest
To know more about Ox take a look at our documentation site.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
log
package log aims to provide common logging interface for the CLI.
|
package log aims to provide common logging interface for the CLI. |
|
pkg
|
|
|
plugins package contains the foundational plugins in Ox as well as the interfaces that allow the extensibility of the ox CLI.
|
plugins package contains the foundational plugins in Ox as well as the interfaces that allow the extensibility of the ox CLI. |
|
base
base package contains the base plugins and hooks to the ox CLI, these plugins are the base commands of the CLI.
|
base package contains the base plugins and hooks to the ox CLI, these plugins are the base commands of the CLI. |
|
base/fix
fix package contains the logics of the fix operations, fix operations are in charge of adapting our source code to comply with newer versions of the CLI.
|
fix package contains the logics of the fix operations, fix operations are in charge of adapting our source code to comply with newer versions of the CLI. |
|
base/generate
generate package provides the base of the generate command which allows to run generators for tools.
|
generate package provides the base of the generate command which allows to run generators for tools. |
|
base/test
test package contains the tooling for the test command on the cli.
|
test package contains the tooling for the test command on the cli. |
|
tools
Package tool`s` contains plugins for different tools used in the development workflow.
|
Package tool`s` contains plugins for different tools used in the development workflow. |
|
tools/db
db packs all db operations under this top level command.
|
db packs all db operations under this top level command. |
|
tools/standard
Standard package provides plugin that performs operations of the Go standard toolset.
|
Standard package provides plugin that performs operations of the Go standard toolset. |
Click to show internal directories.
Click to hide internal directories.