ESC
Type to search across all documentation
Getting Started

Getting Started

This guide walks you through your first session with LogiCoal.

Login

Before using LogiCoal, you need to authenticate:

logicoal login

This opens your browser to coals.ai where you'll log in or create an account. Once authenticated, the browser shows a success message and you can close the tab. Your credentials are saved locally — you only need to do this once.

To check your login status at any time:

logicoal status

This shows your username, team, plan, and remaining token balance.

Launch the Interface

On macOS, the installer automatically opens a Terminal window running LogiCoal after installation. Otherwise, open your terminal and run:

logicoal

If you're not logged in, you'll see a welcome screen prompting you to press Enter to authenticate.

The Interface

Once launched, you'll see:

  • Header bar — Shows your username, plan info, current working directory, connected MCP servers, and remaining credits
  • Chat area — Conversation between you and the AI, with markdown rendering and syntax-highlighted code
  • Input area — Where you type messages and commands
  • Mode indicator — Shows the current operation mode (Normal, Auto, or Plan) in the bottom-left

Your First Conversation

Just type naturally. LogiCoal understands your project context and can work with your codebase directly:

What does this project do?
Find all the TypeScript files that import from the auth module
Add input validation to the signup form

The AI will read files, search your codebase, and suggest or make changes. You don't need to use any special syntax — plain English works.

Tool Indicators

When the AI uses tools, you'll see status indicators in the chat:

Read(src/auth/login.ts)           ← Reading a file
Bash(npm test)                     ← Running a command
Glob(**/*.test.ts)                 ← Searching for files
Write(src/utils/validate.ts)       ← Creating/updating a file

Each indicator shows the tool name and its primary argument. A count of completed tool calls appears as they finish.

Tool Approval

In Normal mode (the default), the AI asks your permission before writing files or running commands. You'll see a prompt like:

Write file: src/utils/validate.ts
  ▸ Approve
    Deny

Navigate with Up/Down arrows and press Enter, or press Y to approve or N to deny directly.

Read-only operations (reading files, searching, listing directories) don't require approval unless they're outside your working directory.

To skip all approval prompts, switch to Auto mode with Shift+Tab or /mode auto. See Operation Modes for details.

Useful First Commands

Command What it does
/help Shows all available commands and current mode
/init Analyzes your project and generates documentation
/mode auto Switches to autonomous mode (no approval prompts)
/clear Clears conversation and starts fresh
/exit Exits LogiCoal (or press Ctrl+C)

Next Steps