First site in 5 minutes
Five commands take you from an empty folder to a checked draft running on your own computer. This walkthrough was run on SpiderCaster 0.1.0 with networking switched off, and the build step took less than a second.
Five steps
Run each command from the SpiderCaster folder. The example is a one-page site for a bike repair shop.
Make a project
python spidercaster.py init projects/my-site writes a brief.md file and an empty copy folder.
Write the words
Put one line about the site in brief.md and your words in copy/overview.md. The first heading becomes the page headline.
Build the draft
python spidercaster.py build projects/my-site --offline --out sites/my-site
Check it
python spidercaster.py check sites/my-site --expect-noindex --project projects/my-site
Preview it
python spidercaster.py serve sites/my-site serves the draft at localhost port 4173, or the next free port.
The whole run
Every command from the five steps, with the words the example used and what the engine printed back.
# Corner Bike Fix
Flat tyres, slipping gears and squeaky brakes, fixed while you wait or by the end of the day.
# What we fix
- Flat tyres: Tube or tyre swapped while you wait.
- Gears: Cables tuned so every gear clicks in.
- Brakes: Pads and cables set so the bike stops straight.
# Questions
Do I need to book?
No. Walk in during opening hours.
Do you sell bikes?
No. We only repair them.$ python spidercaster.py init projects/my-site
project ready: projects/my-site
next: fill brief.md and copy/, then:
python spidercaster.py build projects/my-site --offlineExit code: 0
$ python spidercaster.py build projects/my-site --offline --out sites/my-site
built sites/my-site (mode: offline)
pages: index.html, favicon.svg
tokens: requests=0 ok=0 in=0 out=0 est_cost=$0.0000
index: NOINDEX (default; pass --indexable to flip)
robots: sites/my-site/robots.txt
next: python spidercaster.py check sites/my-site
python spidercaster.py serve sites/my-siteExit code: 0
$ python spidercaster.py check sites/my-site --expect-noindex --project projects/my-site
[pass] ask_after_proof - offer->proof->ask holds
[pass] single_primary_cta - 1 page(s), one visible primary per viewport
[pass] mobile_block - 0 mobile block(s), 360-first
[pass] token_ledger - mode=offline in=0 out=0 est=$0.0000
[pass] cited_text - 1 page(s), every visible string cited
result: 59 pass / 0 fail / 2 warn / 3 skipExit code: 0
favicon.svg
index.html
report.json
robots.txt
site.jsonHow your words become sections
The offline build reads the shape of your writing and picks a section for each part. It never adds a line of its own.
The first heading
Becomes the page headline, and the paragraph under it becomes the lead.
Three or more bullets
Become a features section with one card per bullet. The words before a colon become the card title.
Questions with answers
A question on one line and its answer on the next become an FAQ section.
Price lines
Bullets with a name, a dash, and a price become pricing or menu rows.
A contact heading
Becomes the contact section. Email addresses and phone numbers are picked up from the text.
Everything else
Becomes a plain text section.
What the build writes
The example build printed one line per file, the token count, and the next two commands to run. The site folder held five files.
index.html
The page itself, with the style built in. Nothing loads from another site.
favicon.svg
The small icon browsers show in the tab.
robots.txt
Asks search engines to stay away while the draft is noindex.
site.json
The plan for the page. Edit it and rebuild with build --from at zero tokens.
report.json
The token ledger. The example recorded 0 requests and an estimated cost of $0.0000.
Reading the check result
On the example the checker ended with result: 59 pass / 0 fail / 2 warn / 3 skip.
The two warnings were thin_content, because the example page has only 95 words, and noindex_crawl, because a draft is both noindex and blocked in robots.txt. A warning does not stop the job. A failure does, and the check command then exits with code 1, so a script can stop on it.
Build the same project twice and you get the same page. In this walkthrough the two builds of index.html were identical, byte for byte.