105 docs tagged with "reference"

Use to fill in `x-fibe.gg.metadata.description`, `category`, `source_defaults`, and execution settings such as `job_mode`, `schedule_config`, and `trigger_config`.

Use to write `fibe.gg/path_rule` Traefik path matchers (`Path`, `PathPrefix`, `PathRegexp`) when multiple services share a subdomain. Avoid forbidden matchers.

Use to set the public hostname leftmost label via `fibe.gg/subdomain` - including the root `@`, defaults, allowed character set, and variable interpolation.

Use when reading the current Player's Agent default overrides (LLM provider, settings, etc.) — the JSON shape used by the profile UI.

Use when you need to clear all Player Agent default overrides so the platform's admin defaults apply.

Use when you need to replace the current Player's Agent default overrides. Same JSON shape the profile UI uses. Affects new Agents and unset fields on existing ones.

Use when you need persisted Agent activity, optionally scoped to a runtime conversation. Overseer-only.

Use for Fibe AI Genies, standalone chats, Playground sidecars, Bridge, artefacts, mutters, feedback, job-mode Tricks, CI repair, scheduled jobs, VCS triggers, and mutation-testing automation.

Use when you need to create or upsert a deterministic Agent runtime conversation. Overseer-only.

Use when you need to delete a specific Agent runtime conversation. Overseer-only.

Use when you need to duplicate an existing Agent's configuration (settings, mounted files, defaults). Overseer tool — operates on managed Agents.

Use when you need to stop a running Agent turn. Overseer-only.

Use when you need current conversation-scoped runtime stream state for a managed Agent. Overseer-only.

Use when you need persisted Agent messages, optionally scoped to a runtime conversation. Overseer-only.

Use when you need to check an Agent's runtime reachability, authentication, queue depth, and processing state. Diagnostics for Agent chat health.

Use when you need to send one text message to a managed Agent's chat runtime. Overseer-only.

Use when you need to start (or reconnect) an Agent's runtime chat session on the current Marquee. First step before sending messages.

Use YAML anchors (`&name`) and aliases (`*name`) to share `depends_on`, `environment`, `build`, healthcheck, or label blocks across multiple Fibe services without copy-paste.

Use when you need to upload an Artefact (file/report/plan/result) for the current Agent. Persists to Rails AND mirrors into FIBE_WORKSPACE_PATH if set.

Use when you need to switch session-scoped Fibe API key and/or domain mid-session for multi-tenant work. Validates new creds via /api/me ping by default.

Use to map Compose `build.args` / `build.target` into Fibe `fibe.gg/build_args` (comma-separated KEY=value) and `fibe.gg/build_target`. Includes variable interpolation and parsing rules.

Use to convert a Compose `build:` block into Fibe dynamic-service labels (`fibe.gg/repo_url`, `fibe.gg/dockerfile`, `fibe.gg/branch`) so Fibe clones, builds, and rolls out the service.

Use when you need to invoke a Fibe MCP tool that is registered server-side but not advertised in the current client tool surface (typical when running --tools core).

Use as a diagnostic table for typical errors when converting docker-compose to Fibe templates - unknown labels, bad regex matches, missing repo_url, zerodowntime conflicts, undeclared/unused variables, and trigger/schedule issues.

Use Docker Compose top-level `configs:` to inline small config files (init scripts, conf templates) without bind-mounting from the host. Distinct from Fibe Mounted Files.

Use as the entry point for converting any existing docker-compose.yml into a Fibe Compose template (fibe.gg labels + x-fibe.gg namespace). Orchestrates which surgical skills to load next.

Use to build a Fibe template for a scheduled cron job - daily DB backup, periodic data sync, log cleanup. Combines `metadata.job_mode: true` + `metadata.schedule_config` + watched service.

Use Compose `depends_on` with `condition: service_healthy` / `service_completed_successfully` / `service_started` to order service startup correctly in Fibe templates.

Use when you need to verify Fibe MCP connectivity, API key validity, and current player profile. First call when troubleshooting auth or environment selection.

Use to set `fibe.gg/env_file` for dynamic services so Fibe knows which example env file in the repo to read defaults from. Covers the difference between Compose `env_file:` and Fibe `fibe.gg/env_file`.

Use to decide how a service should be reachable - external public HTTPS via subdomain, internal Basic-Auth-protected HTTPS, sharing a subdomain via path rule, root subdomain, or not exposed at all.

Use to lift `${VAR}` / `${VAR:-default}` Compose interpolations into `x-fibe.gg.variables` so the launcher can configure them, with optional defaults, validation, and path bindings.

Use to answer broad "what can Fibe do?" questions and choose the correct user-facing Fibe feature area without leaking implementation details.

Use when you need to fetch one feedback entry by id, including the full Player comment, source reference, and context.

Use when you need to list all feedback entries (Player comments on Artefacts/Mutters/etc.) for the current Agent. Required reading after major milestones.

Use as the definitive reference for every supported `fibe.gg/*` Docker Compose label - exact value regexes, defaults, required-when rules, and what runtime/schema each enforces.

Use when you need to search GitHub repos across ALL the Player's connected GitHub App installations. Aggregates and deduplicates across orgs/accounts.

Use when you need to mint a short-lived GitHub installation access token for a specific repository. Auto-resolves the correct GitHub App installation.

Use when you need to create a new repo on the Player's connected Gitea (managed or external) and atomically register it as a Fibe Prop.

Use when you need to create a new GitHub repository under the Player's OAuth-connected GitHub account and register it as a Fibe Prop.

Use as the first reference for the meaning of any core Fibe term - Marquee, Playground, Playspec, Template, Trick, Prop, Bazaar, Agent, Mutter, Artefact, Secret, Player, and related concepts.

Use when bootstrapping a greenfield app in one call — creates one or more repos/Props from a template or GitHub repo snapshot, an app-owned template version, a deployed Playground, waits for running, and links it locally to /app/playground.

Use when you need to read the cobra CLI Long help for any fibe subcommand (flag descriptions, examples, payload shapes).

Use to embed `$$var__NAME` (and `$$random__NAME`) inside Compose string values, label values, image tags, URLs, and partial strings - and to understand when the inline form is required vs optional.

Use to decide whether a template should be a long-running HTTP service, a one-shot job (Trick) with `job_watch`, a scheduled job via `schedule_config`, or a VCS-triggered job via `trigger_config`.

Use to convert a Docker Compose template into a Fibe job-mode template (Trick) with `fibe.gg/job_watch`, `x-fibe.gg.metadata.job_mode: true`, and the runtime constraints around restart, replicas, and exposure.

Use when deploying an existing Fibe-compatible Compose config from inline YAML, a local file, or a GitHub repository config file without creating new source repos first.

Use when you need to get filesystem-level info about one local Playground (name, path, playspec, mounts) without an API call.

Use when you need to symlink a local Playground's mounts into a working directory (default /app/playground) so the Agent has direct file access. Brownfield handshake.

Use when you need to create or update one Memory grounded in a local source conversation. Persistent agent memory tied to evidence (groundings + conversation snapshot).

Use when you need to stream Agent events live as MCP progress notifications. Bounded by duration and max_events. For Overseer waiting on Agent output.

Use when you need to list Agent-produced events (messages, activities, mutters, artefacts) with standard pagination. Snapshot mode — for one-shot reads.

Use when converting a docker-compose with many services (5+) that share configuration - leverages YAML anchors, anchored env blocks, anchored depends_on, and `paths:` arrays for variables.

Use when you need to post one short progress/proof/blocker/problem/milestone note as the current Agent. The dedicated Agent progress channel.

Use when you need to retrieve one Agent's mutter stream — the "thinking out loud" feed of progress, proof, problem, and blocker notes — with optional query/status/severity/playground filters.

Use to declare Compose named volumes for persistent data (databases, uploads, caches), and to replace host bind mounts that don't survive Marquee filesystem rules.

Use to convert a static-image Compose service (nginx serving HTML, prebuilt SPA) into a one-service public Fibe template - the minimum viable conversion.

Use to convert a Node.js dev-mode docker-compose (live source mount + hot reload via Vite, Next.js, nodemon) into a Fibe template using `fibe.gg/source_mount` and `fibe.gg/production: false`.

Chain multiple Fibe tool calls into one round-trip with JSONPath bindings. Use when latency matters or multi-step jobs (create→wait→link) need atomicity.

Use when you need to re-fetch a cached fibe_pipeline result by id, optionally projecting a specific JSONPath, within 5 minutes of the original run.

Use when you need to run a single Playground lifecycle action — rollout, hard_restart, stop, start, retry_compose, enable_maintenance, or disable_maintenance. Destructive; requires confirm:true.

Use when you need to fetch comprehensive Playground diagnostics — service/container names, ports, paths, labels, status, urls, recent logs — when troubleshooting a deployment.

Use when you need to fetch a bounded log snapshot for a single Playground service. Async on Rails — returns terminal payload after polling.

Use when you need to stream a Playground service's live logs as MCP progress notifications until duration elapses or max_lines reached. For waiting on a specific log pattern.

Use when an existing deployed playground needs to be transformed end-to-end to a different stack, service shape, source layout, or prop set while preserving its id. Single-call brownfield analog of fibe_greenfield_create. Authors a new template inline if needed and provisions Gitea-backed private Props on the fly for new repos.

Use when you need to block-and-poll until a Playground reaches a target status (running, stopped, has_changes, destroyed, etc.). Required after rollout/start/restart/job triggers.

Use to convert Compose `ports:` declarations into `fibe.gg/expose` labels for public/internal HTTP routing through Traefik.

Use as a generic pattern for "web app + Postgres" Compose templates - the right env wiring, healthchecks, password generation, and volume layout for any framework.

Use to understand Fibe's user-facing product model, core nouns, topology, and normal path from code repository to running Playground without relying on source code details.

Use to convert a Python web docker-compose (FastAPI / Django / Flask) with Postgres into a Fibe template, with optional dev-mode source mount and production zero-downtime variants.

Use to convert a Ruby on Rails docker-compose (web + db + redis + jobs + optional websocket) into a Fibe template.

Use to generate random values for passwords/secrets via `random: true`, mark variables sensitive for launcher UI, and persist them across rollouts in Fibe templates.

Use when you need to verify Fibe's view of multiple GitHub repository URLs in one call — accessibility, App installation status, default branch, etc.

Use when you need to permanently delete a Fibe resource by id (or name for playgrounds/tricks/playspecs/props/marquees/agents). Destructive — requires confirm:true.

Use when you need to fetch a single Fibe resource by id, or by name for playgrounds, tricks, playspecs, props, marquees, and agents. Includes artefact_attachment download.

Use to explain how Fibe resources are created, updated, launched, shared, stopped, completed, upgraded, or retired from a user-facing perspective.

Use when you need to list any flat Fibe resource (playground, prop, marquee, agent, secret, webhook, audit_log, memory, artefact, etc.) with schema-validated filters.

Use when you need a single tool for create/update and resource-scoped operations (attach, mirror, sync, fork, trigger, rerun, action, etc.) across Fibe resources. Schema-validates locally before API call.

Use when no native MCP tool fits and you need a last-resort escape hatch to invoke an arbitrary fibe CLI command when no MCP tool fits. Avoid; native MCP tools and fibe_call are safer.

Use when you need to know what behavior Fibe infers from Compose YAML/labels at runtime (forced lifecycle fields, hidden constraints, stripped keys, and required co-conditions).

Use to add `x-fibe.gg.metadata.schedule_config` to a job-mode Fibe template - cron expression syntax, `marquee_id` requirement, and the relationship with `job_mode: true`.

Use before calling Fibe mutation/list tools that need schemas. Authoritative source for resource/operation JSON schemas. Required reading before calling fibe_resource_mutate, fibe_resource_list, or any tool with a payload field.

Use to decide where a credential or secret-like value belongs - template variable (with optional `random`/`secret`/`sensitive`), Fibe Secrets, or Job ENV - and how to wire it.

Use for Fibe authentication, sessions, sudo mode, two-factor auth, WebAuthn, API keys, Secret Vault, Job ENV, webhooks, audit logs, data portability and notifications.

Use to set up Fibe live source mounting via `fibe.gg/source_mount` plus `fibe.gg/repo_url` and `fibe.gg/production: false`, including framework-specific dev/watch commands and the rules around `node_modules` and build artifacts.

Use when classifying a Compose service as a Fibe static (prebuilt image) or dynamic (source-backed - cloned/built/mounted from a Git repository) service.

Use when you need to dashboard the current player's resource counts, quota usage, rate-limit budget, and subscription plan in one call.

Use to know which Compose keys to delete or rewrite when converting to a Fibe template - `ports`, `container_name`, `hostname`, host-path bind mounts, and Compose-only directives that conflict with Fibe routing/scaling.

Use as the definitive reference for Fibe template variable mechanics - declaration shape, `$$var__NAME` / `$$random__NAME` / `$$root_domain` interpolation, validation regex, defaults, and random secret generation.

Use when an advanced template-author or admin workflow needs the hidden lower-level primitive for patching, overwriting, or switching template versions, including Trick reruns and global template promotion.

Use when you need to bootstrap and launch a Playground directly from an existing import template, without creating a new repo. Greenfield-lite.

Use as the final gate before publishing or submitting a reusable Fibe Compose template - covers safety, validation, naming, defaults, secrets, and security rejects.

Use when you need to search the Fibe Import Template catalog (own + public + team) by full-text or PostgreSQL regex before greenfield/launch.

Use to build a Fibe template that runs a project's test suite on every git push or PR - job-mode + metadata.trigger_config + watched service running pytest/npm test/rspec/etc.

Use when you need to discover the full Fibe MCP tool surface (advertised + hidden). Required first step before fibe_call when targeting a tool not visible in ToolSearch.

Use to add `x-fibe.gg.metadata.trigger_config` to a job-mode template - `event_type: push|pull_request`, repo URL, branch, prop/marquee binding, and `source_defaults` auto-fill.

Use when you need to update the current Agent's display name. Trigger when the conversation topic changes materially.

Use to understand which public validation stage catches which class of Fibe template error and how to drive validation from MCP/CLI without relying on source code internals.

Use to bind a variable to a whole YAML node (env scalar, label value, replica count, image, command element) via `path:` or `paths:`. Includes typing, multiple paths, and label-key path patterns.

Use to convert a typical Wiki.js docker-compose.yml (Node app + Postgres) into a Fibe template - end-to-end before/after with all labels, variables, and metadata explained.

Use to convert a WordPress + MariaDB/MySQL docker-compose into a Fibe template - static images, generated DB password, persistent volumes for wp-content and DB data.

Use as the definitive reference for the `x-fibe.gg` template namespace - variables, metadata, job mode, schedule config, and trigger config blocks.

Use as the definitive reference for the dotted-path syntax used by `x-fibe.gg.variables.*.path` and `paths` to write whole YAML nodes during template compilation.

Use to decide whether to enable `fibe.gg/zerodowntime` on a service - the prerequisites, what to remove, optional healthcheck tuning labels, and when NOT to enable it.

Use to tune the five optional `fibe.gg/healthcheck_*` labels for `fibe.gg/zerodowntime: "true"`. Covers path, interval, timeout, retries, and start_period with realistic values.