Yoink/Docs/Getting Started

Getting Started with Yoink

Learn what Yoink does, the core 3-command workflow, system prerequisites, and runtime diagnostics.

What is Yoink?

Yoink is a single static Go CLI that takes any GitHub repository URL or local directory, discovers every deployable service, provisions required databases and caches, synthesizes optimized multi-stage Dockerfiles and docker-compose.yml, repairs build errors via an autonomous AI healing loop, and verifies live HTTP 200 reachability.

The 3-Command Basic Workflow

Get up and running with any repository in less than 60 seconds:

3-Step Execution Workflow
# 1. Configure your LLM provider (or select Ollama / --no-agent)
yoink setup

# 2. Ingest, generate, build, heal, and verify stack
yoink init https://github.com/monojitgoswami69/certify

# 3. Open the verified running application in your default browser
yoink open

System Prerequisites

  • Git: Required on your system PATH for cloning repositories.
  • Docker Engine + Docker Compose v2: Required at runtime to build and run container stacks (not required if running with --no-build).
  • Go 1.25+: Only required if building Yoink from source code.

Runtime Diagnostics (yoink doctor)

Run yoink doctor at any time to verify that your Docker daemon, Compose v2 plugin, Git, and LLM credentials are ready and configured properly:

yoink doctor output
$ yoink doctor
[✓] Git binary detected on PATH (version 2.44.0)
[✓] Docker daemon is running and responsive
[✓] Docker Compose v2 plugin detected (v2.24.6)
[✓] LLM Provider (Gemini) API key verified
[✓] State directory permissions valid (~/.yoink chmod 0700)

All systems operational!