README
¶
miactl
miactl is the CLI for Mia-Platform Console. It will eventually implement most of the actions you can do
via the UI.
To Start Using miactl
Read the documentation here.
To Start Developing miactl
To start developing the CLI you must have this requirements:
- golang 1.19+
- make
Once you have pulled the code locally, you can build the code with make:
make build
make will download all the dependencies needed and will build the binary for your current system that you can find
in the bin folder.
To build the docker image locally run:
make docker-build
Testing miactl
To run the tests use the command:
make test
Or add the DEBUG_TEST flag to run the test with debug mode enabled:
make test DEBUG_TEST=1
Before sending a PR be sure that all the linter pass with success:
make lint
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
cliconfig
cliconfig package will provide functions for getting the correct configuration for the client, it will correctly handling on disk configuration and overrides
|
cliconfig package will provide functions for getting the correct configuration for the client, it will correctly handling on disk configuration and overrides |
|
cliconfig/api
package api contains the definitions of the struct for the miactl configuration
|
package api contains the definitions of the struct for the miactl configuration |
|
client
client package contains the primiteves to create a new http client for connecting to Mia-Platform Console using the connection options passed to it.
|
client package contains the primiteves to create a new http client for connecting to Mia-Platform Console using the connection options passed to it. |
|
cmd
cmd package create the main miactl root command for cobra and initialize all the subcommands and flags
|
cmd package create the main miactl root command for cobra and initialize all the subcommands and flags |
|
cmd/environments
environments package contains subcommands and functions for managing project environments
|
environments package contains subcommands and functions for managing project environments |
|
cmd/events
events package contains subcommands and functions for managing events
|
events package contains subcommands and functions for managing events |
|
cmd/resources
resources package contains subcommands and functions for managing runtime resources
|
resources package contains subcommands and functions for managing runtime resources |
|
cmd/serviceaccount
serviceaccount package contains subcommands and functions for managing service accounts
|
serviceaccount package contains subcommands and functions for managing service accounts |
|
cmd/serviceaccount/basic
basic package contains the function for creating a basic authentication service account
|
basic package contains the function for creating a basic authentication service account |
|
cmd/serviceaccount/jwt
jwt package contains the function for creating a jwt authentication service account
|
jwt package contains the function for creating a jwt authentication service account |
|
transport
transport package create a http.Transport configured for communicating with Mia-Platform Console
|
transport package create a http.Transport configured for communicating with Mia-Platform Console |
|
util
util package contains utility functions to use in other packages
|
util package contains utility functions to use in other packages |
Click to show internal directories.
Click to hide internal directories.