Review and fix documentation errors across all install guides

Linux fixes:
- NodeSource: setup_lts.x does not exist, replaced with setup_22.x
- Added sudo apt install nodejs as simplest Ubuntu 26.04 option
- nvm version pinned to v0.40.1 (widely verified)
- Added auth token note for Gemini SSE config
- USERNAME placeholders clarified with whoami hint
- systemd service section now covers venv installs

Windows fixes:
- DILIGENCE_PATH placeholder replaced with auto-resolving PowerShell
  using double-quoted here-strings and -replace for JSON backslashes
- Claude Desktop config now sets both standard and Store paths in one block
- Added auth token note for Gemini SSE config
- ChatGPT config path caveated (varies by version)
This commit is contained in:
Claude 2026-08-03 08:01:22 +00:00
parent aba8d42123
commit 9ab9135ca2
2 changed files with 69 additions and 61 deletions

View file

@ -36,8 +36,11 @@ Required for Gemini CLI. Skip if you only plan to use the built-in AI Coach
(see Section 7d).
```bash
# Debian/Ubuntu (via NodeSource)
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
# Debian/Ubuntu — simplest (Ubuntu 26.04 includes Node 22)
sudo apt install -y nodejs npm
# Or via NodeSource for a specific version
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt install -y nodejs
# Fedora
@ -47,7 +50,7 @@ sudo dnf install nodejs
sudo pacman -S nodejs npm
# Or via nvm (any distro)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
source ~/.bashrc
nvm install --lts
```
@ -205,7 +208,23 @@ cat > ~/.gemini/settings.json << 'EOF'
EOF
```
Alternatively, use the stdio launcher:
If your Diligence instance has API token auth enabled (check the Agent page at
`http://localhost:8000/agent`), add headers to the config:
```json
{
"mcpServers": {
"diligence": {
"url": "http://localhost:3001/sse",
"headers": {
"Authorization": "Bearer YOUR_TOKEN_FROM_AGENT_PAGE"
}
}
}
}
```
Alternatively, use the stdio launcher (no token needed — it connects locally):
```json
{
@ -219,7 +238,7 @@ Alternatively, use the stdio launcher:
}
```
Replace `USERNAME` with your actual username.
Replace `USERNAME` with your actual Linux username (run `whoami` to check).
**Use:**
@ -271,7 +290,7 @@ cat > ~/.config/Claude/claude_desktop_config.json << 'EOF'
EOF
```
Replace `USERNAME` with your actual username.
Replace `USERNAME` with your actual Linux username (run `whoami` to check).
If using a virtual environment, use the full path to the venv Python:
@ -398,6 +417,12 @@ sudo systemctl daemon-reload
sudo systemctl enable --now diligence
```
If using a virtual environment, change `ExecStart` to:
```
ExecStart=/home/USERNAME/Downloads/Diligence-main/.venv/bin/python -m diligence
```
Check status:
```bash

View file

@ -149,35 +149,40 @@ Create or edit the settings file:
```powershell
mkdir "$env:USERPROFILE\.gemini" -ErrorAction SilentlyContinue
Set-Content "$env:USERPROFILE\.gemini\settings.json" @'
$dp = ("$env:USERPROFILE\Downloads\Diligence-main") -replace '\\','\\\\'
@"
{
"mcpServers": {
"diligence": {
"command": "python",
"args": ["mcp_stdio.py"],
"cwd": "DILIGENCE_PATH"
"cwd": "$dp"
}
}
}
'@
"@ | Set-Content "$env:USERPROFILE\.gemini\settings.json"
```
Replace `DILIGENCE_PATH` with your actual path, using double backslashes:
`C:\\Users\\giord\\Downloads\\Diligence-main`
**Alternatively**, Gemini CLI supports SSE directly (unlike Claude Desktop), so you
can point it at the running MCP server without the stdio script:
can point it at the running MCP server without the stdio script. If your Diligence
instance has API token auth enabled (check `http://localhost:8000/agent`), include
the token in headers. Open the settings file in Notepad and paste:
```json
{
"mcpServers": {
"diligence": {
"url": "http://localhost:3001/sse"
"url": "http://localhost:3001/sse",
"headers": {
"Authorization": "Bearer YOUR_TOKEN_FROM_AGENT_PAGE"
}
}
}
}
```
Omit the `headers` block if no token is shown on the Agent page.
**Use:**
1. Start Diligence in one terminal (`python -m diligence`)
@ -203,42 +208,31 @@ install from the Microsoft Store. Sign in with your free Claude account.
Claude Desktop reads its config from different paths depending on install method.
Set both to be safe:
**Standard install:**
Generate and save the config (this auto-resolves your Downloads path):
```powershell
$dp = ("$env:USERPROFILE\Downloads\Diligence-main") -replace '\\','\\\\'
$json = @"
{
"mcpServers": {
"diligence": {
"command": "python",
"args": ["mcp_stdio.py"],
"cwd": "$dp"
}
}
}
"@
# Standard install path
mkdir "$env:APPDATA\Claude" -ErrorAction SilentlyContinue
Set-Content "$env:APPDATA\Claude\claude_desktop_config.json" @'
{
"mcpServers": {
"diligence": {
"command": "python",
"args": ["mcp_stdio.py"],
"cwd": "DILIGENCE_PATH"
}
}
}
'@
$json | Set-Content "$env:APPDATA\Claude\claude_desktop_config.json"
# Microsoft Store install path (set both to be safe)
$storePath = "$env:LOCALAPPDATA\Packages\Claude_pzs8sxrjxfjjc\LocalCache\Roaming\Claude"
if (Test-Path $storePath) { $json | Set-Content "$storePath\claude_desktop_config.json" }
```
**Microsoft Store install:**
```powershell
Set-Content "$env:LOCALAPPDATA\Packages\Claude_pzs8sxrjxfjjc\LocalCache\Roaming\Claude\claude_desktop_config.json" @'
{
"mcpServers": {
"diligence": {
"command": "python",
"args": ["mcp_stdio.py"],
"cwd": "DILIGENCE_PATH"
}
}
}
'@
```
Replace `DILIGENCE_PATH` with your actual path using double backslashes:
`C:\\Users\\giord\\Downloads\\Diligence-main`
**Important:** Do NOT use the "Add custom connector" button in Claude Desktop's UI.
That is for remote MCP servers and may have plan restrictions. The config file
approach above is for local MCP and works on the free plan.
@ -263,22 +257,11 @@ approach above is for local MCP and works on the free plan.
**Configure MCP:**
```powershell
mkdir "$env:APPDATA\ChatGPT" -ErrorAction SilentlyContinue
Set-Content "$env:APPDATA\ChatGPT\chatgpt_config.json" @'
{
"mcpServers": {
"diligence": {
"command": "python",
"args": ["mcp_stdio.py"],
"cwd": "DILIGENCE_PATH"
}
}
}
'@
```
Replace `DILIGENCE_PATH` with your actual path using double backslashes.
MCP configuration is shared between ChatGPT Desktop and OpenAI Codex CLI.
The config file location may vary by version — check OpenAI's documentation
for the current path. As of mid-2026, it is typically at
`%APPDATA%\ChatGPT\chatgpt_config.json`. Use the same JSON format as
Claude Desktop (Section 7b) with your Diligence path.
**Enable Developer Mode:** Settings > Developer Mode > ON