Skip to content

Commit 6d20ecb

Browse files
release/1.4.0
AI-Architect [1.4.0] ============== New Features - Added stop / pause / resume controls for indexing. - Added single-step installer for fresh installations. Enhancements - Migrated all configuration to a centralized configuration location. - Optimized index status responses to include cross-repository details. Fixes - Fixed issues in the Kubernetes force-restart flow
2 parents 10aa1d6 + 847171b commit 6d20ecb

4 files changed

Lines changed: 317 additions & 114 deletions

File tree

README.md

Lines changed: 50 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -216,62 +216,33 @@ Setting up AI Architect has three main steps:
216216

217217
Once the indexing is complete, you can configure AI Architect MCP server in any coding or chat agent that supports MCP. This guide will walk you through installing and setting up AI Architect in a self-hosted environment.
218218

219-
### Step 1- Download AI Architect
219+
### Step 1- Install AI Architect
220220

221-
Download the latest version of AI Architect package from our **[GitHub repository](https://github.com/gitbito/ai-architect/releases)**.
222-
223-
---
224-
225-
### Step 2- Start Docker Desktop / Docker Service
226-
227-
Before proceeding with the installation, ensure **Docker Desktop / Docker Service** is running on your system. If it's not already open, launch **Docker Desktop** and wait for it to fully start before continuing.
228-
229-
---
230-
231-
### Step 3- Extract the downloaded AI Architect package
221+
Before proceeding with the installation, ensure **Docker Desktop / Docker Service** or **Kubernetes cluster** is running on your system. If it's not already running, launch it and wait for it to fully start before continuing.
232222

233223
Open your terminal:
234224
- **Linux/macOS:** Use your standard terminal application
235225
- **Windows (WSL2):** Launch the **Ubuntu** application from the **Start menu**
236226

237-
Navigate to the folder where you downloaded the file. You can either work directly in your **Downloads** folder or move the file to any preferred location first, then navigate there in the terminal.
238-
- **Linux/macOS:** `cd /path/to/your/folder`
239-
- **Windows (WSL2):** `cd /mnt/c/Users/YourUsername/path/to/folder`
240-
241-
Create a directory for AI Architect and extract the downloaded package into it:
242-
243-
```bash
244-
mkdir bito-ai-architect
227+
Execute the installation command:
245228
```
246-
247-
```bash
248-
tar -xzf bito-ai-architect-*.tar.gz -C bito-ai-architect
229+
curl -fsSL https://aiarchitect.bito.ai/install.sh | bash
249230
```
250231

251-
> **Note:** Replace `bito-ai-architect-*.tar.gz` with the actual name of the file you downloaded.
232+
The installation script will:
233+
- Download the latest Bito AI Architect package
234+
- Extract it to your system
235+
- Initialize the setup process
252236

253-
Navigate to the extracted folder:
254-
255-
```bash
256-
cd bito-ai-architect
257-
```
237+
> **Installing dependencies:** The AI Architect setup process will automatically check for required tools on your system. If any dependencies are missing (such as `jq`, which is needed for JSON processing), you'll be prompted to install them. Simply type `y` and press `Enter` to proceed with the installation.
258238
259239
---
260240

261-
### Step 4- Run setup
241+
### Step 2- Configuration
262242

263243
The setup script will guide you through configuring AI Architect with your Git provider and LLM credentials. The process is interactive and will prompt you for the necessary information step by step.
264244

265-
**To begin setup, run:**
266-
267-
```bash
268-
./setup.sh
269-
```
270-
271-
> **Installing dependencies:**
272-
> The AI Architect setup process will automatically check for required tools on your system. If any dependencies are missing (such as `jq`, which is needed for JSON processing), you'll be prompted to install them. Simply type `y` and press `Enter` to proceed with the installation.
273-
274-
**You'll need to provide the following details when prompted:**
245+
#### You'll need to provide the following details when prompted:
275246
> Refer to the [Prerequisites section](#2-prerequisites) for details on how to obtain these.
276247
- **Deployment type** - Choose between **Docker** or **Kubernetes** based on your infrastructure requirements
277248
- **Bito API Key** (required) - Your Bito authentication key
@@ -287,9 +258,11 @@ The setup script will guide you through configuring AI Architect with your Git p
287258
288259
---
289260

290-
### Step 5- Add repositories
261+
### Step 3- Add repositories
262+
263+
Once your Git account is connected successfully, Bito automatically detects your repositories and populates the `/usr/local/etc/bitoarch/.bitoarch-config.yaml` file with an initial list. Review this file to confirm which repositories you want to index — feel free to remove any that should be excluded or add others as needed. Once the list looks correct, save the file, and continue with the steps below.
291264

292-
Once your Git account is connected successfully, Bito automatically detects your repositories and populates the `.bitoarch-config.yaml` file with an initial list. Review this file to confirm which repositories you want to index — feel free to remove any that should be excluded or add others as needed. Once the list looks correct, save the file, and continue with the steps below.
265+
> For versions older than 1.4.0, configuration file can be found in installation directory.
293266
294267
Below is an example of how the `.bitoarch-config.yaml` file is structured:
295268

@@ -315,11 +288,11 @@ Once you select an option, your **Bito MCP URL** and **Bito MCP Access Token** w
315288
To manually apply the configuration, run this command:
316289

317290
```bash
318-
bitoarch add-repos .bitoarch-config.yaml
291+
bitoarch add-repos /usr/local/etc/bitoarch/.bitoarch-config.yaml
319292
```
320293
---
321294

322-
### Step 6- Start indexing
295+
### Step 4- Start indexing
323296

324297
Once your repositories are configured, AI Architect needs to analyze and index them to build the knowledge graph. This process scans your codebase structure, dependencies, and relationships to enable context-aware AI assistance.
325298

@@ -335,23 +308,42 @@ Once the indexing is complete, you can configure AI Architect MCP server in any
335308

336309
---
337310

338-
### Step 7- Check indexing status
311+
### Step 5- Check indexing status
339312

340313
Run this command to check the status of your indexing:
341314

342315
```bash
343316
bitoarch index-status
344317
```
345318

346-
**Status indicators:**
319+
**Example output:**
320+
321+
```
322+
Configured Repositories
323+
324+
Configured: 1
325+
Note: Config can change while an index session is running.
326+
327+
Index Status (Repo-level)
328+
329+
State: ✓ success
330+
Progress: 1 / 1 completed
331+
332+
Index Status (Cross-Repo)
333+
334+
State: ✓ success
335+
```
336+
337+
**What each section represents:**
347338
348-
- `running` - Indexing is in progress
349-
- `success` - All repositories indexed
350-
- `failed` - Check logs for errors
339+
- **Configured Repositories:** Shows how many repositories are added in your config file for indexing.
340+
- **Index Status (Repo-level):** Shows the indexing progress for each individual repository.
341+
- **Index Status (Cross-Repo):** Shows the status of indexes that combine and process information across multiple repositories.
342+
- **Overall Status:** Provides a single summary indicating whether indexing is still running, completed successfully, or failed.
351343
352344
---
353345
354-
### Step 8- Check MCP server details
346+
### Step 6- Check MCP server details
355347
356348
To manually check the MCP server details (e.g. **Bito MCP URL** and **Bito MCP Access Token**), use the following command:
357349
@@ -380,16 +372,16 @@ bitoarch rotate-mcp-token <new-token>
380372

381373
You can update the repository list and re-index anytime after the initial setup through `.bitoarch-config.yaml` file.
382374

383-
Edit `.bitoarch-config.yaml` file to add/remove repositories:
375+
Edit `/usr/local/etc/bitoarch/.bitoarch-config.yaml` file to add/remove repositories:
384376

385377
```bash
386-
vim .bitoarch-config.yaml
378+
vim /usr/local/etc/bitoarch/.bitoarch-config.yaml
387379
```
388380

389381
To apply the changes, run this command:
390382

391383
```bash
392-
bitoarch update-repos .bitoarch-config.yaml
384+
bitoarch update-repos /usr/local/etc/bitoarch/.bitoarch-config.yaml
393385
```
394386

395387
Start the re-indexing process using this command:
@@ -483,6 +475,9 @@ Quick reference to CLI commands for managing Bito's AI Architect.
483475
|---------|-------------|---------|
484476
| `bitoarch index-repos` | Trigger workspace repository indexing | Simple index without parameters |
485477
| `bitoarch index-status` | Check indexing status | View progress and state |
478+
| `bitoarch pause-indexing` | Pause ongoing indexing process | `bitoarch pause-indexing` |
479+
| `bitoarch resume-indexing` | Resume paused indexing process | `bitoarch resume-indexing` |
480+
| `bitoarch stop-indexing` | Stop indexing completely | `bitoarch stop-indexing` |
486481
| `bitoarch index-repo-list` | List all repositories | `bitoarch index-repo-list --status active` |
487482
| `bitoarch show-config` | Show current configuration | `bitoarch show-config --raw` |
488483

@@ -492,8 +487,8 @@ Quick reference to CLI commands for managing Bito's AI Architect.
492487
|---------|-------------|---------|
493488
| `bitoarch add-repo <namespace>` | Add single repository | `bitoarch add-repo myorg/myrepo` |
494489
| `bitoarch remove-repo <namespace>` | Remove repository | `bitoarch remove-repo myorg/myrepo` |
495-
| `bitoarch add-repos <file>` | Load configuration from YAML | `bitoarch add-repos .bitoarch-config.yaml` |
496-
| `bitoarch update-repos <file>` | Update configuration from YAML | `bitoarch update-repos .bitoarch-config.yaml` |
490+
| `bitoarch add-repos <file>` | Load configuration from YAML | `bitoarch add-repos /usr/local/etc/bitoarch/.bitoarch-config.yaml` |
491+
| `bitoarch update-repos <file>` | Update configuration from YAML | `bitoarch update-repos /usr/local/etc/bitoarch/.bitoarch-config.yaml` |
497492
| `bitoarch repo-info <name>` | Get detailed repository info | `bitoarch repo-info myrepo --dependencies` |
498493

499494
### Service operations

bito-ai-architect-1.3.2.tar.gz

-148 KB
Binary file not shown.

bito-ai-architect-1.4.0.tar.gz

162 KB
Binary file not shown.

0 commit comments

Comments
 (0)