# CodeMate Terminal

## Get Started with CodeTerm AI

#### Installation

Getting started with CodeTerm AI is quick and easy. Follow these simple steps to install the AI-powered terminal on your system:

1. **Download the Installer**\
   Visit the official download page at [cli.codemate.ai](https://cli.codemate.ai/) and select the installer for your operating system (currently available for **Linux** and **macOS**).
2. **Run the Installer**\
   Open the downloaded file and follow the on-screen instructions to complete the installation.
3. **Verify Installation**\
   Open your terminal and run:

```
codeterm --version
```

You should see the installed version number, confirming successful setup.

### Basic Usage

Once installed, CodeTerm AI brings intelligent natural language interaction and AI assistance right into your terminal.

* **Natural Language Commands**\
  Simply type your requests in plain English:

```
> find all large files in downloads
```

CodeTerm AI interprets and executes the matching terminal commands instantly.

* **AI Chat Interface**\
  Start an AI chat session by running:

```
> codeterm chat
```

Use this to generate code snippets, get explanations, or receive recommendations-all within your terminal environment.

***

### Feature Walkthrough

#### 1. Natural Language to Command Conversion

Convert plain English requests into precise terminal commands without memorizing complex syntax.

#### 2. AI-Powered Chat Interface

Engage in real-time conversations with an AI assistant for coding help, explanations, and optimization tips.

#### 3. Command Autocomplete

Benefit from smart autocomplete suggestions that speed up command entry and reduce errors.

#### 4. Privacy-Focused Design

CodeTerm AI operates locally on your machine, ensuring your code and commands remain fully private without any external data transmission.

#### 5. Cross-Platform Compatibility

Available on major Unix-based systems: Linux and macOS. Compatible with popular shells such as Bash and Zsh.

#### Support & Resources

* **Documentation:** [docs.codemate.ai](/codemate-terminal.md)
* **GitHub Repository:** [github.com/CodeMate-AI/codeterm](https://github.com/CodeMate-AI/codeterm)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.codemate.ai/feature-walkthrough/codemate-terminal.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.