Tools Overview

Tools Overview

Sky provides a comprehensive suite of tools for Starlark development. Each tool is installable individually or all at once.

Quick Install

# Install all tools
go install github.com/albertocavalcante/sky/cmd/...@latest

# Or install individually
go install github.com/albertocavalcante/sky/cmd/skylint@latest
go install github.com/albertocavalcante/sky/cmd/skyfmt@latest
go install github.com/albertocavalcante/sky/cmd/skytest@latest

Tool Categories

Analysis

skylint - Fast linting with 20+ rules

skycheck - Deep static analysis

Formatting

skyfmt - Consistent code formatting

Testing

skytest - Test runner with coverage

skycov - Coverage reporting

Development

skyrepl - Interactive REPL

skydoc - Documentation generator

skyquery - Codebase queries

Analysis Tools

skylint

Fast static linter with 20+ configurable rules for code quality, style, and correctness.

skylint src/
skylint --format=json src/       # Machine-readable output
skylint --config=.skylint.yaml   # Custom configuration

Full documentation

skycheck

Deep static analyzer with type inference and cross-file analysis.

skycheck src/
skycheck --strict src/           # Stricter checking
skycheck --format=sarif src/     # SARIF output for GitHub

Full documentation

Formatting

skyfmt

Code formatter for consistent style across your codebase. Compatible with Buildifier formatting.

skyfmt file.star                 # Format and print to stdout
skyfmt --write src/              # Format files in place
skyfmt --check src/              # Check without modifying (CI mode)

Full documentation

Testing

skytest

Test runner with built-in assertions, fixtures, and coverage collection.

skytest tests/                   # Run all tests
skytest --coverage tests/        # Collect coverage data
skytest --filter="test_add*"     # Filter by test name

Features:

• Test discovery (*_test.star, test_*.star)
• Built-in assert module with eq, ne, true, fails, etc.
• setup() and teardown() support
• Coverage collection via starlark-go-x hooks
• JSON and JUnit output formats

Full documentation

skycov

Coverage reporter that converts raw coverage data to industry-standard formats.

skycov coverage.json                       # Text summary
skycov --format=cobertura coverage.json    # Cobertura XML
skycov --format=lcov coverage.json         # LCOV format
skycov --min-coverage=80 coverage.json     # Threshold check

Full documentation

Documentation

skydoc

Generate documentation from Starlark docstrings in Markdown or HTML.

skydoc src/                      # Generate docs
skydoc --output=docs src/        # Specify output directory
skydoc --format=html src/        # HTML output

Full documentation

Query Tools

skyquery

Query Starlark codebases to understand dependencies and structure.

skyquery 'deps(//src:lib)'       # Show dependencies
skyquery 'rdeps(//src:util)'     # Show reverse dependencies
skyquery 'allpaths(//a, //b)'    # Find paths between targets

Full documentation

Interactive

skyrepl

Interactive REPL for experimenting with Starlark code.

skyrepl
>>> x = [1, 2, 3]
>>> [i * 2 for i in x]
[2, 4, 6]
>>> def greet(name): return "Hello, " + name
>>> greet("World")
"Hello, World"

Full documentation

Tool Comparison

Tool	Purpose	Speed	Output Formats
skylint	Linting	Fast	Text, JSON, SARIF
skycheck	Deep analysis	Slower	Text, JSON, SARIF
skyfmt	Formatting	Fast	-
skytest	Testing	Medium	Text, JSON, JUnit
skycov	Coverage	Fast	Text, JSON, Cobertura, LCOV
skydoc	Documentation	Medium	Markdown, HTML

CI Integration

All tools support CI-friendly output formats and exit codes:

# GitHub Actions example
- name: Lint
  run: skylint --format=sarif src/ > results.sarif

- name: Format check
  run: skyfmt --check src/

- name: Test with coverage
  run: |
    skytest --coverage tests/
    skycov --min-coverage=80 coverage.json

See CI Integration for complete examples.

Next Steps

skylint Configure linting rules

skytest Write and run tests

Coverage Collect code coverage

Plugins Extend Sky with plugins