Diagnose this daemon
Checks whether this daemon is ready to run teams and reports every problem it finds:
the data directory and database, installed agents and their settings, teams and the
tools they need, registered workspaces whose folders are missing, and runs that errored
in the last 24 hours. Takes no fields; send {}.
Problems are reported in the reply (overall: fail), not as an error status.
From the CLI: cliq doctor.
No credential is needed from this machine. From another host, send Authorization: Bearer with a dispatch token CliqHub signed for this daemon or a cliq_tok_… personal token of a user in the daemon’s realm; this only works once the daemon is connected to CliqHub. See Authentication.
POST
/
v1
/
workspaces
/
doctor
Diagnose this daemon
curl --request POST \
--url http://127.0.0.1:4900/v1/workspaces/doctor \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "http://127.0.0.1:4900/v1/workspaces/doctor"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('http://127.0.0.1:4900/v1/workspaces/doctor', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4900",
CURLOPT_URL => "http://127.0.0.1:4900/v1/workspaces/doctor",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:4900/v1/workspaces/doctor"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://127.0.0.1:4900/v1/workspaces/doctor")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:4900/v1/workspaces/doctor")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"overall": "fail",
"checks": [
{
"name": "database",
"pass": true,
"message": "sqlite open (/home/dev/.cliqrc/cliq.db)"
},
{
"name": "agents",
"pass": true,
"message": "3 registered"
},
{
"name": "recent_runs",
"pass": false,
"message": "2 errored run(s) in the last 24h"
}
],
"agents": [
{
"name": "claude-code",
"agent_type": "exec",
"ready": false,
"issues": [
"missing required setting 'api_key'"
],
"setup_hint": "cliq settings set agents.claude-code.api_key <value>"
}
],
"workspaces": [],
"teams": [
{
"slug": "code-review",
"scope": "acme",
"issues": []
}
]
}
}
Authorizations
Not needed from the same machine. From another host: a dispatch JWT CliqHub signed for this daemon, or a cliq_tok_… personal token whose user is in the daemon's realm.
Body
application/json
The body is of type object.
⌘I
Diagnose this daemon
curl --request POST \
--url http://127.0.0.1:4900/v1/workspaces/doctor \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "http://127.0.0.1:4900/v1/workspaces/doctor"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('http://127.0.0.1:4900/v1/workspaces/doctor', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4900",
CURLOPT_URL => "http://127.0.0.1:4900/v1/workspaces/doctor",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:4900/v1/workspaces/doctor"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://127.0.0.1:4900/v1/workspaces/doctor")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:4900/v1/workspaces/doctor")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"overall": "fail",
"checks": [
{
"name": "database",
"pass": true,
"message": "sqlite open (/home/dev/.cliqrc/cliq.db)"
},
{
"name": "agents",
"pass": true,
"message": "3 registered"
},
{
"name": "recent_runs",
"pass": false,
"message": "2 errored run(s) in the last 24h"
}
],
"agents": [
{
"name": "claude-code",
"agent_type": "exec",
"ready": false,
"issues": [
"missing required setting 'api_key'"
],
"setup_hint": "cliq settings set agents.claude-code.api_key <value>"
}
],
"workspaces": [],
"teams": [
{
"slug": "code-review",
"scope": "acme",
"issues": []
}
]
}
}