Reference · the tools · environments

Install an environment

What it does

Install a template onto this box as a new environment, and start it. Usually about 30 seconds; it returns its URL and the ssh target for the workbench. A big template takes minutes: then it answers once the install is under way, and environment_status shows each step and says if it fails. Calling it again with the same name and template reports on that install and starts nothing new -- until it has failed: then it starts a fresh install, and environment_logs still shows what the failed one printed. The environment is claimed for you as soon as it is made. If the user did not say which template they want, prefer one whose description matches their words rather than guessing. ASK THE USER WHAT TO CALL IT before calling this, and tell them WHY when you ask: the name becomes the address of the running app — <name>.<box>.<account>.bettik.dev, so an environment called hello on frank's home box answers at hello.home.frank.bettik.dev — which they will type and share for months. It is not a label on a list. A box full of environments named after what they were installed from is a box nobody can navigate. Anything is accepted: it is lowercased and punctuation becomes hyphens, so "Catan v2" becomes "catan-v2". If that changes what they asked for, this tool says so and you should repeat it — nobody should learn their URL by accident. (formerly install_bundle)

What it needs to know

template

The template to install, as list_templates names it: "worbblepop", "worbblepop@3", "org/name", or one someone shared with you, "owner/name".

name

What the user chose to call it. Becomes the hostname, so it is lowercased and punctuation becomes hyphens; pass what they said and let this tool tidy it.

holder

What your session calls itself. The new environment is claimed for you, so another session does not start editing it underneath you. Use something recognisable — whoever collides with you sees this name.

session_id · optional

Your Claude session id ("cse_…"), from `bettik-session-id`. Lets the box tell later whether this session ended or merely went quiet.

confirm · optional

Go ahead although the box or its pool is above 75% memory (a box nearly out of memory is refused regardless) -- only after telling the user what the box said and asking.

box · optional

Which box: its name and account, "home.frank" or "jordan.northwind", or just "home" when only one of your boxes is called that. Omit it for your current box (switch_box changes it; list_boxes says which it is).

session_box · optional

The box this session runs on, if it runs on one of yours: its name, as the on-box instructions give it ("frankh90.hemlane"). With it, a call that names no box is checked against your current box.

Where it lands

On one of your boxes: the one named in box, or your default box when none is named.