Create a Ravi app scaffold from the app contract
curl --request POST \
--url http://localhost:3000/api/v1/apps/scaffold \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"command": "<string>",
"description": "<string>",
"dryRun": true,
"force": true,
"name": "<string>",
"skipSkill": true,
"skipSpec": true,
"skipUi": true
}
'import requests
url = "http://localhost:3000/api/v1/apps/scaffold"
payload = {
"id": "<string>",
"command": "<string>",
"description": "<string>",
"dryRun": True,
"force": True,
"name": "<string>",
"skipSkill": True,
"skipSpec": True,
"skipUi": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
command: '<string>',
description: '<string>',
dryRun: true,
force: true,
name: '<string>',
skipSkill: true,
skipSpec: true,
skipUi: true
})
};
fetch('http://localhost:3000/api/v1/apps/scaffold', 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/apps/scaffold",
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([
'id' => '<string>',
'command' => '<string>',
'description' => '<string>',
'dryRun' => true,
'force' => true,
'name' => '<string>',
'skipSkill' => true,
'skipSpec' => true,
'skipUi' => true
]),
CURLOPT_HTTPHEADER => [
"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/apps/scaffold"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"command\": \"<string>\",\n \"description\": \"<string>\",\n \"dryRun\": true,\n \"force\": true,\n \"name\": \"<string>\",\n \"skipSkill\": true,\n \"skipSpec\": true,\n \"skipUi\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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/apps/scaffold")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"command\": \"<string>\",\n \"description\": \"<string>\",\n \"dryRun\": true,\n \"force\": true,\n \"name\": \"<string>\",\n \"skipSkill\": true,\n \"skipSpec\": true,\n \"skipUi\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/apps/scaffold")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"command\": \"<string>\",\n \"description\": \"<string>\",\n \"dryRun\": true,\n \"force\": true,\n \"name\": \"<string>\",\n \"skipSkill\": true,\n \"skipSpec\": true,\n \"skipUi\": true\n}"
response = http.request(request)
puts response.read_body{
"builder": {
"command": "<string>",
"reviewChecklist": [
"<string>"
],
"skill": "<string>",
"spec": "<string>"
},
"cliPath": "<string>",
"command": "<string>",
"description": "<string>",
"dryRun": true,
"files": [
{
"action": "planned",
"kind": "cli",
"path": "<string>"
}
],
"force": true,
"id": "<string>",
"manifest": {},
"manifestPath": "<string>",
"name": "<string>",
"nextCommands": [
"<string>"
],
"skill": "<string>",
"skillPath": "<string>",
"specPath": "<string>"
}apps
Create a Ravi app scaffold from the app contract
POST
/
api
/
v1
/
apps
/
scaffold
Create a Ravi app scaffold from the app contract
curl --request POST \
--url http://localhost:3000/api/v1/apps/scaffold \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"command": "<string>",
"description": "<string>",
"dryRun": true,
"force": true,
"name": "<string>",
"skipSkill": true,
"skipSpec": true,
"skipUi": true
}
'import requests
url = "http://localhost:3000/api/v1/apps/scaffold"
payload = {
"id": "<string>",
"command": "<string>",
"description": "<string>",
"dryRun": True,
"force": True,
"name": "<string>",
"skipSkill": True,
"skipSpec": True,
"skipUi": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
command: '<string>',
description: '<string>',
dryRun: true,
force: true,
name: '<string>',
skipSkill: true,
skipSpec: true,
skipUi: true
})
};
fetch('http://localhost:3000/api/v1/apps/scaffold', 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/apps/scaffold",
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([
'id' => '<string>',
'command' => '<string>',
'description' => '<string>',
'dryRun' => true,
'force' => true,
'name' => '<string>',
'skipSkill' => true,
'skipSpec' => true,
'skipUi' => true
]),
CURLOPT_HTTPHEADER => [
"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/apps/scaffold"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"command\": \"<string>\",\n \"description\": \"<string>\",\n \"dryRun\": true,\n \"force\": true,\n \"name\": \"<string>\",\n \"skipSkill\": true,\n \"skipSpec\": true,\n \"skipUi\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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/apps/scaffold")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"command\": \"<string>\",\n \"description\": \"<string>\",\n \"dryRun\": true,\n \"force\": true,\n \"name\": \"<string>\",\n \"skipSkill\": true,\n \"skipSpec\": true,\n \"skipUi\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/apps/scaffold")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"command\": \"<string>\",\n \"description\": \"<string>\",\n \"dryRun\": true,\n \"force\": true,\n \"name\": \"<string>\",\n \"skipSkill\": true,\n \"skipSpec\": true,\n \"skipUi\": true\n}"
response = http.request(request)
puts response.read_body{
"builder": {
"command": "<string>",
"reviewChecklist": [
"<string>"
],
"skill": "<string>",
"spec": "<string>"
},
"cliPath": "<string>",
"command": "<string>",
"description": "<string>",
"dryRun": true,
"files": [
{
"action": "planned",
"kind": "cli",
"path": "<string>"
}
],
"force": true,
"id": "<string>",
"manifest": {},
"manifestPath": "<string>",
"name": "<string>",
"nextCommands": [
"<string>"
],
"skill": "<string>",
"skillPath": "<string>",
"specPath": "<string>"
}Body
application/json
Stable app id, e.g. music or music/player
Implementation CLI command (default: generated bun cli.ts)
Short app description
Print planned files without writing
Overwrite scaffold contracts while preserving an existing implementation CLI
Human display name
Do not create a skill skeleton
Do not create an app spec skeleton
Do not include interfaces.ui in the manifest
Response
Success — body conforms to the @Returns schema.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes