# Neoswarm (neosh)

> A terminal workspace for running coding agents, built the way Neovim is built:
> one core in Rust, any model, and every feature shipped as a TypeScript plugin
> on a public API. If you can see it, a plugin can replace it.

Every docs page below is plain markdown. For the complete corpus in one file,
including the canonical repository docs and the full typed plugin API source,
fetch https://neoswarm.dev/llms-full.txt.

## Docs

- [Start Guide](https://neoswarm.dev/docs/index.md)
- [Installation](https://neoswarm.dev/docs/installation.md)
- [Concepts](https://neoswarm.dev/docs/concepts.md)
- [Configuration](https://neoswarm.dev/docs/configuration.md)
- [Options](https://neoswarm.dev/docs/options.md)
- [Keymaps](https://neoswarm.dev/docs/keymaps.md)
- [Appearance](https://neoswarm.dev/docs/appearance.md)
- [Sidebar and projects](https://neoswarm.dev/docs/sidebar.md)
- [Models](https://neoswarm.dev/docs/models.md)
- [Machines](https://neoswarm.dev/docs/machines.md)
- [Writing a plugin](https://neoswarm.dev/docs/plugins.md)
- [The plugin API](https://neoswarm.dev/docs/plugin-api.md)
- [Panels and extension points](https://neoswarm.dev/docs/panels.md)
- [Keys](https://neoswarm.dev/docs/keys.md)
- [Docs for agents](https://neoswarm.dev/docs/agents.md)

## For agents writing plugins

- [skill.md](https://neoswarm.dev/skill.md): the plugin-development skill (SKILL.md format), install to ~/.claude/skills/neosh-plugins/SKILL.md
- [agents.md](https://neoswarm.dev/agents.md): the same content without frontmatter, for appending to an AGENTS.md or rules file

## Full corpus

- [llms-full.txt](https://neoswarm.dev/llms-full.txt): every docs page, the repository's canonical config and plugin guides, the testing guide, and the complete @neosh/api TypeScript source

## Source

- [Repository](https://github.com/neoswarm/neosh)
- [Plugin API package](https://github.com/neoswarm/neosh/tree/main/plugins/api)
- [Bundled plugins, the worked examples](https://github.com/neoswarm/neosh/tree/main/plugins/builtin)