# CLI Commands

These are shell commands you run from your terminal — not from inside the LogiCoal chat interface.

## `logicoal`

Launch the interactive chat UI. This is the main way to use LogiCoal.

```bash
logicoal
```

If you're not authenticated, you'll be prompted to log in first.

## `logicoal login`

Authenticate with your coals.ai account. Opens your default browser to the login page.

```bash
logicoal login
```

A local server starts on port 9876 to receive the OAuth callback. Once you log in through the browser, credentials are stored locally and you can close the browser tab.

## `logicoal logout`

Clear stored credentials and log out.

```bash
logicoal logout
```

## `logicoal status`

Show your authentication status, username, team, plan, and remaining token balance.

```bash
logicoal status
```

## `logicoal health`

Check if the LogiCoal API is reachable.

```bash
logicoal health
```

Returns a success or failure message with the API URL.

## `logicoal config`

Show current configuration values.

```bash
logicoal config
```

### Set a custom API URL

For self-hosted or staging environments:

```bash
logicoal config --api-url https://my-instance.example.com
```

## `logicoal init`

Scaffold the `.coals/` workspace directory structure in the current directory.

```bash
logicoal init
```

This creates the `.coals/` directory with subdirectories for plans, research, artifacts, prompts, and progress. It does **not** generate `.COAL.md` — that requires the `/init` slash command inside the interactive chat, which uses AI to analyze your codebase.

Use `--force` or `-f` to regenerate the directory structure:

```bash
logicoal init --force
```

See [Project Initialization](/content/docs/project-init/index.html) for full details.

## `logicoal update`

Check for and install the latest version.

```bash
logicoal update
```

LogiCoal also checks for updates automatically on startup and shows a notification if one is available.

## `logicoal --version`

Print the current version.

```bash
logicoal --version
```

## `logicoal --help`

Show the CLI help with all available commands.

```bash
logicoal --help
```