Skip to content
Sky

Quick Start

Quick Start

Section titled “Quick Start”

Get up and running with Sky in 5 minutes.

1. Install

Section titled “1. Install”
Terminal window
go install github.com/albertocavalcante/sky/cmd/...@latest

2. Create a Starlark File

Section titled “2. Create a Starlark File”
hello.star
def greet(name):
    """Greet someone by name."""
    return "Hello, " + name + "!"


message = greet("World")
print(message)

3. Format It

Section titled “3. Format It”
Terminal window
skyfmt hello.star

4. Lint It

Section titled “4. Lint It”
Terminal window
skylint hello.star

5. Create a Test

Section titled “5. Create a Test”
hello_test.star
load("hello.star", "greet")


def test_greet():
    assert.eq(greet("World"), "Hello, World!")
    assert.eq(greet("Sky"), "Hello, Sky!")


def test_greet_empty():
    assert.eq(greet(""), "Hello, !")

6. Run Tests

Section titled “6. Run Tests”
Terminal window
skytest hello_test.star

Output:

PASS  test_greet
PASS  test_greet_empty


Results: 2 passed, 0 failed

7. Collect Coverage

Section titled “7. Collect Coverage”
Terminal window
skytest --coverage hello_test.star
skycov coverage.json

Output:

Coverage Report
===============
hello.star    100.0% (3/3 lines)
Total: 100.0% (3/3 lines)

Next Steps

Section titled “Next Steps”