# Silvan Best Practices

> Guidelines for Silvan CLI and UI UX consistency, output conventions, JSON and verbosity behavior, error recovery, onboarding, and operator workflows. Use when implementing or reviewing CLI output, help or onboarding flows, error handling, JSON schemas, run lifecycle UX, or dashboard features in this repo. Use when this capability is needed.

- Skill: `tomevault-io/silvan-best-practices` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/silvan-best-practices`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/silvan-best-practices/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/silvan-best-practices

---


# Silvan Best Practices

## Overview

Use this skill to keep Silvan's UX consistent and operator-grade. It provides a shared checklist and references for CLI output, errors, JSON behavior, onboarding, and UI surfaces.

## Quick workflow

1. Identify the UX surface (CLI output, JSON, errors, onboarding/help, UI).
2. Read `references/best-practices.md` for conventions and guardrails.
3. Reuse or extend shared utilities instead of adding one-off formatting.
4. Ensure success confirmations, next steps, and actionable errors.
5. Update tests and docs when behavior or output changes.

## Definition of done

- Output uses semantic colors and consistent formatting.
- `--json` output is schema-stable and error-safe.
- Errors include recovery steps and docs links when relevant.
- Commands never exit silently on success.
- TTY and non-TTY output are both readable.

## References

- `references/best-practices.md`: canonical UX and output standards.

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/stevekinney) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-15 -->

