Skip to content

Commit 5ffd18d

Browse files
authored
Revise insights documentation in README
Updated insights section in README to clarify features and commands.
1 parent 34cc0af commit 5ffd18d

1 file changed

Lines changed: 87 additions & 5 deletions

File tree

README.md

Lines changed: 87 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<a href="#6-sso-authentication">SSO Authentication</a>
6363
</li>
6464
<li>
65-
<a href="#7-insights-git-jira--confluence">Insights (Git, Jira & Confluence)</a>
65+
<a href="#7-insights">Insights</a>
6666
</li>
6767
<li>
6868
<a href="#8-configuring-ai-architect-for-bito-ai-code-review-agent">Configuring AI Architect for Bito AI Code Review Agent</a>
@@ -549,12 +549,89 @@ SSO sessions are configurable with the following defaults:
549549

550550
<br />
551551

552-
<!-- Insights (Jira & Confluence) -->
552+
<!-- Insights -->
553553

554554
## 7. Insights
555555

556-
AI Architect optionally enriches the knowledge graph with insights from Git history, Jira, and Confluence giving coding agents additional context about project activity, planned work, and documentation. Insights can be enabled and configured post-install; see the [Insights Documentation](https://docs.bito.ai/ai-architect/insights) for details.
556+
AI Architect optionally enriches the knowledge graph with context from Jira, and Confluence giving coding agents deeper understanding of project activity, planned work, and documentation.
557557

558+
> **Note:** Insights is an optional feature. Repository indexing and MCP functionality work without it.
559+
560+
---
561+
562+
### Enabling and disabling features
563+
564+
Enable one or more insights sources during installation (when prompted) or at any time post-install:
565+
566+
```bash
567+
bitoarch insights enable git
568+
bitoarch insights enable ticket-tracker
569+
bitoarch insights enable docs
570+
```
571+
572+
Each `enable` command runs an interactive setup that collects the required credentials.
573+
574+
To disable a feature:
575+
576+
```bash
577+
bitoarch insights disable git
578+
bitoarch insights disable ticket-tracker
579+
bitoarch insights disable docs
580+
```
581+
582+
---
583+
584+
### Running insights
585+
586+
```bash
587+
bitoarch insights run
588+
bitoarch insights run --force # Force a full refresh
589+
```
590+
591+
---
592+
593+
### Checking status
594+
595+
```bash
596+
bitoarch insights status
597+
```
598+
599+
---
600+
601+
### Managing Jira project keys
602+
603+
```bash
604+
bitoarch insights tracker-projects list
605+
bitoarch insights tracker-projects add KEY1 KEY2
606+
bitoarch insights tracker-projects remove KEY1
607+
bitoarch insights discover-tracker-projects
608+
```
609+
610+
---
611+
612+
### Updating credentials
613+
614+
```bash
615+
bitoarch insights update-ticket-tracker
616+
bitoarch insights update-doc-config
617+
```
618+
619+
---
620+
621+
### Viewing configuration
622+
623+
```bash
624+
bitoarch insights config
625+
```
626+
627+
---
628+
629+
### Configuring lookback period
630+
631+
```bash
632+
bitoarch insights set-lookback git 90
633+
bitoarch insights set-lookback ticket-tracker 180
634+
```
558635

559636
---
560637

@@ -679,9 +756,14 @@ Quick reference to CLI commands for managing Bito's AI Architect.
679756
|---------|-------------|---------|
680757
| `bitoarch insights enable [feature]` | Enable an insights feature (`git`, `ticket-tracker`, or `docs`) | `bitoarch insights enable git` |
681758
| `bitoarch insights disable [feature]` | Disable an insights feature | `bitoarch insights disable ticket-tracker` |
682-
| `bitoarch insights run [--force]` | Run insights analysis. `--force` re-analyzes all data | `bitoarch insights run --force` |
683-
| `bitoarch insights status` | Show insights analysis progress | `bitoarch insights status` |
759+
| `bitoarch insights run [--force]` | Run insights. `--force` forces a full refresh | `bitoarch insights run` |
760+
| `bitoarch insights status` | Show insights progress | `bitoarch insights status` |
684761
| `bitoarch insights config` | Show insights configuration | `bitoarch insights config` |
762+
| `bitoarch insights set-lookback [feature] [days]` | Set lookback period for a feature | `bitoarch insights set-lookback git 90` |
763+
| `bitoarch insights tracker-projects [action]` | Manage Jira project keys (`list`, `add`, `remove`, `set`) | `bitoarch insights tracker-projects add PROJ` |
764+
| `bitoarch insights discover-tracker-projects` | List accessible Jira projects | `bitoarch insights discover-tracker-projects` |
765+
| `bitoarch insights update-ticket-tracker` | Update ticket-tracker credentials | `bitoarch insights update-ticket-tracker` |
766+
| `bitoarch insights update-doc-config` | Update Confluence credentials | `bitoarch insights update-doc-config` |
685767

686768
### Output options
687769

0 commit comments

Comments
 (0)