You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: README.md
+50-55Lines changed: 50 additions & 55 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -216,62 +216,33 @@ Setting up AI Architect has three main steps:
216
216
217
217
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.
218
218
219
-
### Step 1- Download AI Architect
219
+
### Step 1- Install AI Architect
220
220
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.
232
222
233
223
Open your terminal:
234
224
-**Linux/macOS:** Use your standard terminal application
235
225
-**Windows (WSL2):** Launch the **Ubuntu** application from the **Start menu**
236
226
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.
> **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
252
236
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.
258
238
259
239
---
260
240
261
-
### Step 4- Run setup
241
+
### Step 2- Configuration
262
242
263
243
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.
264
244
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:
275
246
> Refer to the [Prerequisites section](#2-prerequisites) for details on how to obtain these.
276
247
-**Deployment type** - Choose between **Docker** or **Kubernetes** based on your infrastructure requirements
277
248
-**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
287
258
288
259
---
289
260
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.
291
264
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.
293
266
294
267
Below is an example of how the `.bitoarch-config.yaml` file is structured:
295
268
@@ -315,11 +288,11 @@ Once you select an option, your **Bito MCP URL** and **Bito MCP Access Token** w
315
288
To manually apply the configuration, run this command:
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.
325
298
@@ -335,23 +308,42 @@ Once the indexing is complete, you can configure AI Architect MCP server in any
335
308
336
309
---
337
310
338
-
### Step 7- Check indexing status
311
+
### Step 5- Check indexing status
339
312
340
313
Run this command to check the status of your indexing:
341
314
342
315
```bash
343
316
bitoarch index-status
344
317
```
345
318
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:**
347
338
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.
351
343
352
344
---
353
345
354
-
### Step 8- Check MCP server details
346
+
### Step 6- Check MCP server details
355
347
356
348
To manually check the MCP server details (e.g. **Bito MCP URL** and **Bito MCP Access Token**), use the following command:
0 commit comments