Import provider rules into .ravi/rules/imported (dry-run without --write)
curl --request POST \
--url http://localhost:3000/api/v1/rules/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cwd": "<string>",
"force": true,
"includeUser": true,
"source": "all",
"write": true
}
'import requests
url = "http://localhost:3000/api/v1/rules/import"
payload = {
"cwd": "<string>",
"force": True,
"includeUser": True,
"source": "all",
"write": True
}
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({cwd: '<string>', force: true, includeUser: true, source: 'all', write: true})
};
fetch('http://localhost:3000/api/v1/rules/import', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/rules/import",
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([
'cwd' => '<string>',
'force' => true,
'includeUser' => true,
'source' => 'all',
'write' => true
]),
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://localhost:3000/api/v1/rules/import"
payload := strings.NewReader("{\n \"cwd\": \"<string>\",\n \"force\": true,\n \"includeUser\": true,\n \"source\": \"all\",\n \"write\": true\n}")
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://localhost:3000/api/v1/rules/import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cwd\": \"<string>\",\n \"force\": true,\n \"includeUser\": true,\n \"source\": \"all\",\n \"write\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/rules/import")
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 = "{\n \"cwd\": \"<string>\",\n \"force\": true,\n \"includeUser\": true,\n \"source\": \"all\",\n \"write\": true\n}"
response = http.request(request)
puts response.read_body{
"candidates": [
{}
],
"counts": {},
"cwd": "<string>",
"force": true,
"includeUser": true,
"rulesDir": "<string>",
"sources": [
{}
],
"write": true
}rules
Import provider rules into .ravi/rules/imported (dry-run without --write)
POST
/
api
/
v1
/
rules
/
import
Import provider rules into .ravi/rules/imported (dry-run without --write)
curl --request POST \
--url http://localhost:3000/api/v1/rules/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cwd": "<string>",
"force": true,
"includeUser": true,
"source": "all",
"write": true
}
'import requests
url = "http://localhost:3000/api/v1/rules/import"
payload = {
"cwd": "<string>",
"force": True,
"includeUser": True,
"source": "all",
"write": True
}
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({cwd: '<string>', force: true, includeUser: true, source: 'all', write: true})
};
fetch('http://localhost:3000/api/v1/rules/import', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/rules/import",
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([
'cwd' => '<string>',
'force' => true,
'includeUser' => true,
'source' => 'all',
'write' => true
]),
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://localhost:3000/api/v1/rules/import"
payload := strings.NewReader("{\n \"cwd\": \"<string>\",\n \"force\": true,\n \"includeUser\": true,\n \"source\": \"all\",\n \"write\": true\n}")
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://localhost:3000/api/v1/rules/import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cwd\": \"<string>\",\n \"force\": true,\n \"includeUser\": true,\n \"source\": \"all\",\n \"write\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/rules/import")
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 = "{\n \"cwd\": \"<string>\",\n \"force\": true,\n \"includeUser\": true,\n \"source\": \"all\",\n \"write\": true\n}"
response = http.request(request)
puts response.read_body{
"candidates": [
{}
],
"counts": {},
"cwd": "<string>",
"force": true,
"includeUser": true,
"rulesDir": "<string>",
"sources": [
{}
],
"write": true
}Authorizations
Runtime context-key (rctx_*) issued by the Ravi gateway. Required for every non-open scope. Bootstrap the first key with ravi daemon init-admin-key; rotate, derive, and revoke via the ravi context family. Specs: runtime/context-keys, sdk/auth.
Body
application/json
Workspace cwd to import into (default: current directory)
Overwrite existing imported rule files
Also import user-level ~/.claude/rules and ~/.agents/rules
Source provider: all, claude, agents
Write files. Without this, import runs as dry-run
Response
Success — body conforms to the @Returns schema.