# console

**Repository Path**: go-libs/console

## Basic Information

- **Project Name**: console
- **Description**: This lib provides a console manager
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-10
- **Last Updated**: 2024-08-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Console

Provide a console for the application bootstrap.

```
import "gitee.com/go-libs/console"
```

## Provider

Create example provider for command runner like follows.

- `Run`(container `*console.Container`, command `*console.Command`) - `Required`
- `After`(container `*console.Container`, command `*console.Command`, err `error`)
- `Before`(container `*console.Container`, command `*console.Command`) `error`

```
type Example struct{}

func (o *Example) Run(container *console.Container, command *console.Command) (err error) {
    return
}
```

## Provider

```text
func main(){
    command := console.NewCommand("example")
    command.SetDescription("Example command in main")
    command.SetProvider(&Example{})

    container := console.NewContainer()
    container.add(command)
    container.Run()
}
```

## Run console

You can run follow script on terminal.

```shell
cd /data/sketch
go run main.go example
```