Manboster

https://manboster.dev/docs
Admin
Manboster is a lightweight, zero-trust AI agent written in Go designed for safe tool execution and...
Tokens:6,193
Snippets:76
Trust Score:2.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Manboster via Go

Source: https://manboster.dev/docs/quickstart

Use the Go toolchain to install the latest version of Manboster.

```shell
go install github.com/manboster/manboster/cmd/manboster@latest
```

--------------------------------

### Start development with make

Source: https://manboster.dev/docs/contribute/start

Use the make command to initialize the development environment.

```shell
make run (params)
```

--------------------------------

### Install Go modules

Source: https://manboster.dev/docs/contribute/start

Download the necessary Go dependencies required for development.

```shell
go mod download
```

--------------------------------

### Start the Manboster daemon

Source: https://manboster.dev/docs/quickstart

Run the application in background daemon mode.

```shell
./manboster start
```

--------------------------------

### Start Configuration TUI with Docker or Podman

Source: https://manboster.dev/docs/container

Run the configuration TUI. Must stop the container first, otherwise it will report a running error. Use the 'config' command.

```shell
# If you are using Docker:
docker stop manboster-container
docker run --remove -it -v ./manboster-data:/app/manboster/ ghcr.io/manboster/manboster manboster config

# If you are using Podman:
podman stop manboster-container
podman run --remove -it -v ./manboster-data:/app/manboster/ ghcr.io/manboster/manboster manboster config
```

--------------------------------

### Deploy Manboster with Docker or Podman

Source: https://manboster.dev/docs/container

Start a detached container with restart policy and a fixed name. Use this after onboarding completes.

```shell
# If you are using Docker:
docker run -dit -v ./manboster-data:/app/manboster/ --restart=unless-stopped --name manboster-container ghcr.io/manboster/manboster

# If you are using Podman:
podman run -dit -v ./manboster-data:/app/manboster/ --restart=unless-stopped --name manboster-container ghcr.io/manboster/manboster
```

--------------------------------

### Install Manboster on macOS via Homebrew

Source: https://manboster.dev/docs/quickstart

Use Homebrew to install Manboster on Apple Silicon Macs.

```shell
brew tap MZWNET/tap
brew install MZWNET/tap/manboster
```

--------------------------------

### Install Manboster on AOSC OS

Source: https://manboster.dev/docs/quickstart

Use the oma package manager to install Manboster on AOSC OS.

```shell
oma install manboster
```

--------------------------------

### Manboster Application Startup Flow

Source: https://manboster.dev/docs/contribute/architecture

Shows the execution flow of a Manboster application from entrypoint to engine. The flow starts with `/cmd/manboster/main.go` which activates i18n, then activates cobra, loads providers via `/internal/loader`, and finally opens the engine.

```text
`/cmd/manboster/main.go`(check i18n) -> `/internal/cli/manboster/app` -> `/internal/loader` -> `/internal/engine`
```

--------------------------------

### Compose deployment command for Docker and Podman Compose

Source: https://manboster.dev/docs/container

Start the Compose deployment in detached mode after onboarding succeeds.

```shell
# docker compose
docker compose up -d

# podman compose
podman compose up -d
```

--------------------------------

### Clone the Manboster repository

Source: https://manboster.dev/docs/contribute/start

Use this command to clone the repository to your local machine. Ensure Git is installed and SSH keys are configured beforehand.

```shell
git clone git@github.com:/your-username/manboster.git
```

--------------------------------

### Example of Manboster Tool Call Request

Source: https://manboster.dev/docs/hachimi

Displays the status of a tool call request with Hachimi's activation status indicated by emojis.

```text
🐱➖ 🤖✅ 🌐 Manboster Request Tool: http://127.0.0.1:8080/api
```

--------------------------------

### Manboster onboard commands for Docker and Podman

Source: https://manboster.dev/docs/container

Run the initial configuration command for a singleton instance. Include the -it and -v flags to mount the data directory and enable interactive mode.

```shell
# If you are using Docker:
docker run --remove -it -v ./manboster-data:/app/manboster/ ghcr.io/manboster/manboster manboster onboard

# If you are using Podman:
podman run --remove -it -v ./manboster-data:/app/manboster/ ghcr.io/manboster/manboster manboster onboard
```

--------------------------------

### Create and checkout a new branch

Source: https://manboster.dev/docs/contribute/start

Create a new branch for your changes and switch to it.

```shell
git branch fix/your-branch-name
git checkout fix/your-branch-name
```

--------------------------------

### Verify SHA256 checksum on Windows

Source: https://manboster.dev/docs/quickstart

Use certutil to verify the integrity of the downloaded binary on Windows.

```shell
certutil -hashfile [Path To Manboster]
```

--------------------------------

### Compose onboard command for Docker and Podman Compose

Source: https://manboster.dev/docs/container

Initial onboard configuration for Compose deployments. The container is run with --rm to clean up after exit.

```shell
# docker compose
docker compose run --rm manboster manboster onboard

# podman compose
podman compose run --rm manboster manboster onboard
```

--------------------------------

### Compose Configuration TUI commands for Docker and Podman Compose

Source: https://manboster.dev/docs/container

Stop the container and run the config CLI. Must be done when the container is stopped, otherwise a running error occurs.

```shell
# docker compose
docker compose stop manboster
docker compose run --rm manboster manboster config

# podman compose 
podman compose stop manboster
podman compose run --rm manboster manboster config
```

--------------------------------

### Retrieve Manboster logs

Source: https://manboster.dev/docs/quickstart

View the logs generated by the Manboster daemon.

```shell
./manboster log
```

--------------------------------

### Check Manboster daemon status

Source: https://manboster.dev/docs/quickstart

Verify the current status of the background daemon.

```shell
./manboster status
```

--------------------------------

### Verify SHA256 checksum on macOS or Linux

Source: https://manboster.dev/docs/quickstart

Use sha256 or shasum to verify the integrity of the downloaded binary on Unix-like systems.

```shell
sha256 or shasum -a 256
```

--------------------------------

### docker-compose.yml services field for Manboster

Source: https://manboster.dev/docs/container

Add this YAML to the services field of your docker-compose.yml. It sets the image, container name, restart policy, volume mount, and enables TTY.

```yaml
services:
  manboster:
    image: ghcr.io/manboster/manboster
    container_name: manboster-container
    restart: unless-stopped
    volumes:
      - ./manboster-data:/app/manboster/
    stdin_open: true 
    tty: true
```

--------------------------------

### Push changes to your repository

Source: https://manboster.dev/docs/contribute/start

Push your local branch to your remote fork before opening a pull request.

```shell
git push origin fix/your-branch-name
```

--------------------------------

### Restart the Manboster daemon

Source: https://manboster.dev/docs/quickstart

Restart the background daemon process.

```shell
./manboster restart
```

--------------------------------

### Memory Occupation Calculation

Source: https://manboster.dev/docs/hachimi

Calculation for determining the total memory usage of the Hachimi model based on file size and context length.

```text
400MB * 1.2 + 250MB = 480 + 250 = 730MB
```

--------------------------------

### Manboster Engine Message Handling Flow

Source: https://manboster.dev/docs/contribute/architecture

Shows the flow of a message through the Manboster engine, from chat provider to response. The flow includes preprocessing, distribution, handling, and sending back via `chatProvider.Send`.

```text
Chat Provider -> PreProcessor -> distribute.go -> handler.go -> handler -> chatProvider.Send ...
```

--------------------------------

### Official container address

Source: https://manboster.dev/docs/container

The container image is published on GitHub Container Registry (ghcr.io).

```shell
ghcr.io/manboster/manboster
```

--------------------------------

### Stop the Manboster daemon

Source: https://manboster.dev/docs/quickstart

Terminate the background daemon process.

```shell
./manboster stop
```
Tokens:
Raw