Project layout
A project is a folder with a brief and your words. A build turns it into a site folder of plain files, and writes a record of the plan and the token count next to the pages.
The project folder
The init command makes the first two items. The third is optional.
brief.md
What the site is for, who reads it, the tone, and anything that must or must not appear.
copy folder
Your words, as Markdown, plain text, or JSON files. Each heading starts a new section.
assets.json
An optional list of local photos and images, shaped as {"images": {"name": "path"}}. Web addresses for images are dropped, because pages never load files from another site.
The site folder
Without --out, a build writes to sites/ followed by a short name made from the page title.
index.html
The page, with its style built in.
favicon.svg
The tab icon, kept beside the page.
robots.txt
Blocks crawlers while the site is noindex, and allows them after an indexable build.
sitemap.xml
Written only by an indexable build with --host.
site.json
The plan for the build. Edit it and rebuild with build --from at zero tokens.
report.json
The token ledger for the run: mode, provider, requests, tokens in and out, and an estimated cost.
One site folder
The files from the first-site example, and the token ledger it wrote.
favicon.svg
index.html
report.json
robots.txt
site.json{
"mode": "offline",
"provider": null,
"noindex": true,
"tokens": {
"requests": 0,
"ok": 0,
"in_tokens": 0,
"out_tokens": 0,
"est_cost_usd": 0
}
}Undo and history
A clean offline build writes straight to the site folder. Changes that are not a clean build keep a copy of the files first.
_attempts folder
Before a refine, an AI plan, or a crew run, the current files are saved in a dated snapshot. The last 10 are kept.
site.json.bak
The refine command also keeps the plan it replaced.
Roll back
python spidercaster.py refine sites/my-site rollback --rollback followed by the snapshot id restores it at zero tokens. In 0.1.0 a word such as rollback must stand in the instruction slot. Each rollback is logged.
The SpiderCaster folder
The engine is one folder of Python files with no extra packages. Version 0.1.0 holds the command file spidercaster.py, the lib folder with the planner, renderer, and checker, the library folder with the molds, frames, seats, and rules, the plugin folder with plugin/cosmos.json, and two demo projects.
Run commands from that folder, or set SPIDERCASTER_HOME to it when you run the spidercaster command from somewhere else.