SSH Access

boat ssh bx_f7k2q9hd
boat ssh bx_f7k2q9hd "cd /home/user/my-repo && npm test"
boat ssh bx_f7k2q9hd -- bash -lc "cd /home/user/my-repo && npm test"
boat ssh bx_f7k2q9hd -- bash -s < ./setup.sh

curl -sS -X POST "$BOAT_API_BASE/sandboxes/bx_f7k2q9hd/commands" \
  -H "Authorization: Bearer $BOAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command":"npm test","cwd":"my-repo","timeoutSeconds":60}'

const result = await sandbox.command({
  sandboxId: "bx_f7k2q9hd",
  command: "npm test", cwd: "my-repo", timeoutSeconds: 60,
});
console.log(result.stdout);

from boat_sdk.models.command_request import CommandRequest

result = sandbox.command(
    "bx_f7k2q9hd",
    CommandRequest(command="npm test", cwd="my-repo", timeout_seconds=60),
)
print(result.stdout)

boat info bx_f7k2q9hd
ssh -i ~/.ssh/ascii_box_ed25519 user@<sandbox-ip>

curl -sS -X POST "$BOAT_API_BASE/sandboxes/bx_f7k2q9hd/sshkey" \
  -H "Authorization: Bearer $BOAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"ssh-ed25519 AAAAC3Nza... you@example.com"}'

curl -sS "$BOAT_API_BASE/sandboxes/bx_f7k2q9hd" \
  -H "Authorization: Bearer $BOAT_API_KEY"

await sandbox.sshKey({
  sandboxId: "bx_f7k2q9hd",
  key: "ssh-ed25519 AAAAC3Nza... you@example.com",
});

const info = await sandbox.get({ sandboxId: "bx_f7k2q9hd" });
console.log(info.sandbox.ip);

from boat_sdk.models.ssh_key_request import SshKeyRequest

sandbox.ssh_key("bx_f7k2q9hd", SshKeyRequest(key="ssh-ed25519 AAAAC3Nza... you@example.com"))
info = sandbox.get("bx_f7k2q9hd")
print(info.sandbox.ip)

boat ssh bx_f7k2q9hd   # fetches and pins the current host key itself

resp="$(curl -sS -X POST "$BOAT_API_BASE/sandboxes/bx_f7k2q9hd/sshkey" \
  -H "Authorization: Bearer $BOAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"key\":\"$(cat ~/.ssh/id_ed25519.pub)\"}")"

echo "bx_f7k2q9hd $(echo "$resp" | jq -r .hostKey)" > ~/.ssh/known_hosts_bx_f7k2q9hd

# sshEndpoint ("host:port") is set when the machine has no public IPv4 of its own
endpoint="$(echo "$resp" | jq -r '.sshEndpoint // empty')"
host="${endpoint%:*}"; port="${endpoint##*:}"
[ -n "$endpoint" ] || { host="$(echo "$resp" | jq -r .machineIp)"; port=22; }

ssh -p "$port" \
    -o StrictHostKeyChecking=yes \
    -o UserKnownHostsFile=~/.ssh/known_hosts_bx_f7k2q9hd \
    -o HostKeyAlias=bx_f7k2q9hd \
    user@"$host"

const { hostKey, machineIp, sshEndpoint } = await sandbox.sshKey({
  sandboxId: "bx_f7k2q9hd",
  key: "ssh-ed25519 AAAAC3Nza... you@example.com",
});
// write `bx_f7k2q9hd ${hostKey}` to a known_hosts file, then connect with HostKeyAlias=bx_f7k2q9hd
// to sshEndpoint ("host:port") when it is set, else to machineIp on port 22

from boat_sdk.models.ssh_key_request import SshKeyRequest

resp = sandbox.ssh_key("bx_f7k2q9hd", SshKeyRequest(key="ssh-ed25519 AAAAC3Nza... you@example.com"))
# write f"bx_f7k2q9hd {resp.host_key}" to a known_hosts file, then connect with HostKeyAlias=bx_f7k2q9hd
# to resp.ssh_endpoint ("host:port") when it is set, else to resp.machine_ip on port 22

boat scp ./local-file.txt bx_f7k2q9hd:/home/user/
boat scp bx_f7k2q9hd:/home/user/output.zip ./output.zip

curl -sS -X PUT "$BOAT_API_BASE/sandboxes/bx_f7k2q9hd/files" \
  -H "Authorization: Bearer $BOAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"notes/input.txt","content":"hello\n","encoding":"utf8"}'

curl -L -o output.zip "$BOAT_API_BASE/sandboxes/bx_f7k2q9hd/artifacts?path=output.zip" \
  -H "Authorization: Bearer $BOAT_API_KEY"

await sandbox.writeFile({
  sandboxId: "bx_f7k2q9hd",
  path: "notes/input.txt", content: "hello\n", encoding: "utf8",
});

const artifact = await sandbox.artifact({ sandboxId: "bx_f7k2q9hd", path: "output.zip" });

from boat_sdk.models.file_write_request import FileWriteRequest

sandbox.write_file("bx_f7k2q9hd", FileWriteRequest(
    path="notes/input.txt",
    content="hello\n",
    encoding="utf8",
))
artifact = sandbox.artifact("bx_f7k2q9hd", "output.zip")