turbo-editors/configs · README.md

⑂ main

README.md · 64 lines · 4.4 KBmarkdown    Blame HistoryRaw
   1# Turbo Editors — configuration samples
3Ready-made project configurations for the [Turbo editors](https://rickub.com/turbo-editors): one directory per kind of project, each holding the editor's own directory — `.turbo-go`, `.turbo-rust` — with its settings, snippets, tools and, in the `-with-agents` variants, its coding agents.
5You do not clone this repository to use it. Every Turbo editor can fetch a directory from it straight into your project.
7## Load a configuration into a project
9From the directory of your project, give the editor the URL of the sample as the browser shows it:
12cd my-go-project
13turbo-go -load-config https://rickub.com/turbo-editors/configs/tree/main/golang-init
16The editor looks for the `.turbo-go` directory inside `golang-init`, copies it into the current directory, prints what arrived, and exits:
19Copied /path/to/my-go-project/.turbo-go from https://git.rickub.com/turbo-editors/configs.git (main):
20  settings.toml
21  snippets.toml
22  tools.toml
25Then start the editor as usual — `turbo-go`, `turbo-go main.go` — and the settings, snippets and tools are in force.
27Each editor looks for its own directory: `turbo-rust` copies the `.turbo-rust` of the sample you point it at, `turbo-python` a `.turbo-python`, and so on. Pointing turbo-rust at a Go sample ends in an error saying there is no `.turbo-rust` there.
30cd my-rust-project
31turbo-rust -load-config https://rickub.com/turbo-editors/configs/tree/main/rustlang-init-with-agents
34### What to know
36- **`git` must be installed.** The fetch is a shallow `git clone`; no token and no account are needed for this public repository.
37- **A project that already has the directory is left alone.** The editor refuses rather than overwrite what the project decided. Move the existing `.turbo-<editor>` away first if you mean to replace it.
38- **The URL may be any of these**: the sample's directory (`…/tree/main/golang-init`), the editor's directory inside it (`…/tree/main/golang-init/.turbo-go`), or a file in it. A branch or tag other than `main` works the same way, from the URL the browser shows for it.
39- **The same works from other forges.** GitHub, GitLab and Codeberg URLs are understood too, so a team can keep its own samples wherever its code lives.
40- **Nothing else is copied**: the sample's `README.md` and anything beside the editor's directory stay here.
42## The samples
44| Directory | Editor | Holds |
45| --- | --- | --- |
46| `golang-init` | turbo-go | `settings.toml` (theme `turbo-dark`, autosave on after 1 s), `snippets.toml`, `tools.toml` (format, lint, build, test, run) |
47| `golang-init-with-agents` | turbo-go | The same, plus `acp.toml` naming two coding agents and the two agent settings files they read |
48| `rustlang-init` | turbo-rust | `settings.toml`, `snippets.toml`, `tools.toml` for a Cargo project |
49| `rustlang-init-with-agents` | turbo-rust | The same, plus the two agents |
51### The agents in the `-with-agents` samples
53`acp.toml` declares two agents, both run as `mm -acp` — a local agent speaking the Agent Client Protocol — each with its own settings file beside it (`agent.mm-dmr-gemma.yaml`, `agent.mm-dmr-mellum.yaml`), passed through the `AGENT_CONFIG` environment variable. Those files point at a **Docker Model Runner** serving models on `http://localhost:12434`, with `host.docker.internal` as the fallback. To use them you need `mm` on your `PATH` and Docker Model Runner running with the named models; otherwise the Agent menu lists the agents and opening one reports that it could not start.
55Edit the two YAML files after loading — the model, the URL, which tools the agent may use — exactly as you would any project file. They are yours once copied.
57## Add a sample
591. Create a directory named for the kind of project: `<language>-<flavour>`.
602. Put the editor's directory inside it — `.turbo-<editor>/` with at least `settings.toml`; add `snippets.toml`, `tools.toml`, and `acp.toml` with its agent files if the sample ships agents. The starter files an editor creates from its Options menu are a good beginning.
613. Add a `README.md` saying what the sample is for and what it assumes is installed.
624. Do not commit anything an agent writes while you test the sample: `.mm/` is ignored for that reason.
64The editors only read `.turbo-<editor>/`, so a sample may hold the same configuration for several editors side by side — `.turbo-go` and `.turbo-rust` in one directory — and each editor takes its own.

🛟 Updated. a3c787d k33g 5h ago	1	# Turbo Editors — configuration samples
	2
	3	Ready-made project configurations for the [Turbo editors](https://rickub.com/turbo-editors): one directory per kind of project, each holding the editor's own directory — `.turbo-go`, `.turbo-rust` — with its settings, snippets, tools and, in the `-with-agents` variants, its coding agents.
	4
	5	You do not clone this repository to use it. Every Turbo editor can fetch a directory from it straight into your project.
	6
	7	## Load a configuration into a project
	8
	9	From the directory of your project, give the editor the URL of the sample as the browser shows it:
	10
	11	```bash
	12	cd my-go-project
	13	turbo-go -load-config https://rickub.com/turbo-editors/configs/tree/main/golang-init
	14	```
	15
	16	The editor looks for the `.turbo-go` directory inside `golang-init`, copies it into the current directory, prints what arrived, and exits:
	17
	18	```
	19	Copied /path/to/my-go-project/.turbo-go from https://git.rickub.com/turbo-editors/configs.git (main):
	20	settings.toml
	21	snippets.toml
	22	tools.toml
	23	```
	24
	25	Then start the editor as usual — `turbo-go`, `turbo-go main.go` — and the settings, snippets and tools are in force.
	26
	27	Each editor looks for its own directory: `turbo-rust` copies the `.turbo-rust` of the sample you point it at, `turbo-python` a `.turbo-python`, and so on. Pointing turbo-rust at a Go sample ends in an error saying there is no `.turbo-rust` there.
	28
	29	```bash
	30	cd my-rust-project
	31	turbo-rust -load-config https://rickub.com/turbo-editors/configs/tree/main/rustlang-init-with-agents
	32	```
	33
	34	### What to know
	35
	36	- `git` must be installed. The fetch is a shallow `git clone`; no token and no account are needed for this public repository.
	37	- A project that already has the directory is left alone. The editor refuses rather than overwrite what the project decided. Move the existing `.turbo-<editor>` away first if you mean to replace it.
	38	- The URL may be any of these: the sample's directory (`…/tree/main/golang-init`), the editor's directory inside it (`…/tree/main/golang-init/.turbo-go`), or a file in it. A branch or tag other than `main` works the same way, from the URL the browser shows for it.
	39	- The same works from other forges. GitHub, GitLab and Codeberg URLs are understood too, so a team can keep its own samples wherever its code lives.
	40	- Nothing else is copied: the sample's `README.md` and anything beside the editor's directory stay here.
	41
	42	## The samples
	43
	44	\| Directory \| Editor \| Holds \|
	45	\| --- \| --- \| --- \|
	46	\| `golang-init` \| turbo-go \| `settings.toml` (theme `turbo-dark`, autosave on after 1 s), `snippets.toml`, `tools.toml` (format, lint, build, test, run) \|
	47	\| `golang-init-with-agents` \| turbo-go \| The same, plus `acp.toml` naming two coding agents and the two agent settings files they read \|
	48	\| `rustlang-init` \| turbo-rust \| `settings.toml`, `snippets.toml`, `tools.toml` for a Cargo project \|
	49	\| `rustlang-init-with-agents` \| turbo-rust \| The same, plus the two agents \|
	50
	51	### The agents in the `-with-agents` samples
	52
	53	`acp.toml` declares two agents, both run as `mm -acp` — a local agent speaking the Agent Client Protocol — each with its own settings file beside it (`agent.mm-dmr-gemma.yaml`, `agent.mm-dmr-mellum.yaml`), passed through the `AGENT_CONFIG` environment variable. Those files point at a Docker Model Runner serving models on `http://localhost:12434`, with `host.docker.internal` as the fallback. To use them you need `mm` on your `PATH` and Docker Model Runner running with the named models; otherwise the Agent menu lists the agents and opening one reports that it could not start.
	54
	55	Edit the two YAML files after loading — the model, the URL, which tools the agent may use — exactly as you would any project file. They are yours once copied.
	56
	57	## Add a sample
	58
	59	1. Create a directory named for the kind of project: `<language>-<flavour>`.
	60	2. Put the editor's directory inside it — `.turbo-<editor>/` with at least `settings.toml`; add `snippets.toml`, `tools.toml`, and `acp.toml` with its agent files if the sample ships agents. The starter files an editor creates from its Options menu are a good beginning.
	61	3. Add a `README.md` saying what the sample is for and what it assumes is installed.
	62	4. Do not commit anything an agent writes while you test the sample: `.mm/` is ignored for that reason.
	63
	64	The editors only read `.turbo-<editor>/`, so a sample may hold the same configuration for several editors side by side — `.turbo-go` and `.turbo-rust` in one directory — and each editor takes its own.