DOCS / GETTING STARTED
From your first prompt to a finished task.
A short guide to the Softlink workflow in your own project.
01. Prepare your project
Open a terminal and go to the project folder you want to work on. Make sure you can review changes through version control.
02. Install & run
TODO: the official install command and runtime requirements are not available yet. Do not treat the block below as an install command. Once Softlink is installed, use these commands:
# TODO: replace with the real install command
softlink # start in the current folder
softlink serve # open the web UI
Supported providers: Anthropic, OpenAI, GitHub Copilot, DeepSeek, and Ollama for local models. TODO: authentication and provider configuration steps will be added once the official docs are available.
03. Describe the goal, not the model
Explain the outcome you need. The router classifies the task; the lead model and subagents carry it out according to its dependencies.
write an email validation function and its tests
04. Review every change
Follow reads, edits, and shell commands. Check diffs and test results before accepting changes. Use the per-model token and cost breakdown to keep track of usage.