OpenShellOrg Docs

OpenShellOrg documentation hub. Antora site aggregating openshellorg projects (SOS + companion tooling docs).
Explore the docs

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Installation
3. Usage
4. Contact

About The Project

Documentation hub for OpenShellOrg — Antora site aggregating org projects, plus SOS certification packages in this monorepo.

Mission

Two complementary tracks:

1. Standardized Operations Syntax (SOS) — unify human-friendly CLI flag syntax and certify compliant tools ("Save Our Syntax").
2. Structured shell architecture — advocate typed data pipelines (endorse Nushell) so stdout is not forced to be both a pipe and a display canvas. Do not reinvent Nushell; document the model and ship helpers.

SOS remains the certification/flag work in this monorepo. Structured-shell direction lives in sibling repos (below).

Related projects

Repo	Role
shell-architecture	Thesis and layers: structured I/O, SOS, terminals, Dev-Centr relationship
nu-require	validate() — require / relaunch under Nushell; optional install offer
nu-emit	C-first API to emit structured rows (JSONL) without hand-rolling JSON

Name collision: We are not NVIDIA OpenShell (agent sandbox runtime). Different problem, similar words.

Dev-Centr recommends/configures Nushell for developers; OpenShellOrg standardizes and tools. Keep the orgs aligned, not merged.

Repository structure

docs/                      # this repo (openshellorg/docs)
├── apps/
│   └── main/              # Main website (SolidStart)
├── docs/                  # Antora hub component (SOS, philosophy, ecosystem)
├── packages/
│   ├── sos-grammar/       # @sos/grammar
│   └── sos-validator-core/
├── assets/brand/
├── antora-playbook.yml    # production (aggregates sibling repos)
├── antora-playbook-local.yml
└── package.json

Path	Description
apps/main	Organization website (SolidStart)
docs/	Hub Antora component (SOS + org pages)
@sos/grammar	Grammar definitions for parsing SOS syntax
@sos/validator-core	Core validation logic for SOS compliance

Installation

Prerequisites

• Node.js (v20+)
• pnpm (v10+)

git clone https://github.com/openshellorg/docs.git
cd docs
pnpm install

Usage

# Apps / packages
pnpm dev
pnpm build

# Docs (Antora)
pnpm docs
# or local sibling checkouts:
pnpm docs:local

Published docs: https://docs.opensh.org/

Org site: https://openshellorg.github.io/

See CHANGELOG.adoc.

Contact

Open Shell Org — openshell@devcentr.org

Project Link: https://github.com/openshellorg/docs

Site: https://openshellorg.github.io

(back to top)