Files
OpenShell/STYLEGUIDE.md
T
Drew Newberry 5518da0a49 refactor: rename navigator- crate prefix to openshell-
Rename all 9 Rust crates from navigator-* to openshell-* to align
with the project rename to OpenShell. This is a comprehensive rename
touching ~1400 references across ~220 files:

- Crate directories and Cargo.toml names/deps
- Proto files (navigator.proto -> openshell.proto), packages, service name
- All Rust source imports (navigator_ -> openshell_) and string literals
- OPA Rego policy package name
- Python proto files and all SDK/e2e imports
- Dockerfiles, CI workflows, build scripts, task files
- Agent skills, documentation, and agent memory files
- Filesystem paths, CLI flags, K8s resource names, TLS cert subjects,
  HTTP headers, gRPC paths

Binary names updated: navigator-server -> openshell-server,
navigator-sandbox -> openshell-sandbox (CLI was already openshell).

The S3 bucket navigator-pypi-artifacts is flagged with a TODO comment
as it requires external coordination to rename.
2026-03-13 00:56:31 -07:00

906 B

STYLE_GUIDE

License Headers

All source files must include SPDX copyright headers.

# Add/update headers
mise run license:update

# Check headers
mise run license:check

Code Style

  • Rust: format with rustfmt, lint with Clippy.
  • Python: format and lint with ruff, type-check with ty.

Recommended workflow before opening a PR:

mise run fmt
mise run lint
mise run ci

CLI Output Style

When printing structured CLI output:

  • Add a blank line after headings.
  • Indent key-value fields by 2 spaces.
  • Use dimmed labels for field keys (for example, "Id:".dimmed()).
  • Use cyan + bold for primary headings.

Good:

Created sandbox:

  Id: cddeeb6d-a4d3-4158-a4d1-bd931f743700
  Name: sandbox-cddeeb6d
  Namespace: openshell

Bad:

Created sandbox:
  Id: cddeeb6d-a4d3-4158-a4d1-bd931f743700
  Name: sandbox-cddeeb6d
  Namespace: openshell