Back to list
stevekinney

silvan-best-practices

by stevekinney

0🍴 0📅 Jan 21, 2026

SKILL.md


name: silvan-best-practices description: 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.

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.

Score

Total Score

60/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon