Skip to content

Commit c074404

Browse files
committed
docs: add iosm-cli reference, CLI implementation section, update status and roadmap
1 parent 2da6364 commit c074404

1 file changed

Lines changed: 29 additions & 13 deletions

File tree

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
**IOSM (Improve -> Optimize -> Shrink -> Modularize)** is an engineering methodology for continuous system improvement. This repository is the **canonical specification repository** for IOSM v1.0 and contains the normative spec, machine-readable schemas, and example artifacts required to understand, adopt, and validate the methodology.
99

10+
> **Looking for the runtime?** See [**iosm-cli**](https://github.com/rokoss21/iosm-cli) — a terminal coding agent that implements IOSM as an engineering runtime with orchestration, MCP, checkpoints, and extensions.
11+
1012
## What This Repository Contains
1113

1214
- The normative IOSM v1.0 specification: [IOSM_SPEC_v1.0.md](IOSM_SPEC_v1.0.md)
@@ -132,31 +134,45 @@ IOSM can be adopted incrementally:
132134
- Future incompatible spec versions should be introduced as new versioned files, for example `IOSM_SPEC_v1.1.md` or `IOSM_SPEC_v2.0.md`.
133135
- Repository-level changes are tracked in [CHANGELOG.md](CHANGELOG.md).
134136

137+
## CLI Implementation
138+
139+
[**iosm-cli**](https://github.com/rokoss21/iosm-cli) is the reference runtime that implements this specification as a terminal coding agent.
140+
141+
```bash
142+
npm install -g iosm-cli
143+
iosm
144+
```
145+
146+
| Feature | Description |
147+
|---------|-------------|
148+
| IOSM cycles | `/init` + `/iosm` — measurable improve/verify loops with artifact output |
149+
| Orchestration | `/orchestrate` — parallel/sequential agents with dependencies, locks, worktrees |
150+
| Operational controls | `/checkpoint`, `/rollback`, `/doctor`, `/memory` |
151+
| Extensibility | MCP servers, TypeScript extensions, SDK, JSON/RPC modes |
152+
| 15+ LLM providers | Anthropic, OpenAI, Gemini, Groq, xAI, OpenRouter, Mistral, and more |
153+
154+
[![npm version](https://img.shields.io/npm/v/iosm-cli?style=flat-square&color=cb3837)](https://www.npmjs.com/package/iosm-cli)
155+
135156
## Current Status
136157

137-
This repository is currently a **specification repository with automated validation**.
158+
This repository is a **specification repository with automated validation**.
138159

139160
What is already present:
140161

141162
- a full normative specification;
142163
- canonical examples and templates;
143-
- machine-readable schemas for the primary artifacts.
164+
- machine-readable schemas for the primary artifacts;
144165
- a reference repository validator;
145-
- CI automation for repository validation.
146-
147-
What is intentionally out of scope for v1.0:
148-
149-
- a reference CLI implementation;
150-
- published case studies.
166+
- CI automation for repository validation;
167+
- a reference CLI implementation: [iosm-cli](https://github.com/rokoss21/iosm-cli).
151168

152169
## Roadmap
153170

154-
The most logical next steps after this repository baseline are:
155-
156-
1. Publish one or more worked case studies.
171+
1. Publish worked case studies.
157172
2. Add visualization guidance for radar charts, index timelines, and drift heatmaps.
158-
3. Add a broader implementation toolkit on top of the repository validator.
173+
3. Expand the implementation toolkit on top of the repository validator.
159174
4. Add additional schemas and conformance fixtures for future spec versions.
175+
5. Deepen integration with [iosm-cli](https://github.com/rokoss21/iosm-cli) runtime.
160176

161177
## Contributing
162178

@@ -172,7 +188,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
172188

173189
## Author
174190

175-
**Emil Rokossovsky**
191+
**Emil Rokossovskiy**
176192

177193
- GitHub: [@rokoss21](https://github.com/rokoss21)
178194
- Email: [ecsiar@gmail.com](mailto:ecsiar@gmail.com)

0 commit comments

Comments
 (0)