​
Init Command

The init command helps initialize repositories and packages for use with Ocuroot. It creates the necessary configuration files to work with the Ocuroot system.

​
Usage

ocuroot init repo
ocuroot init package [path]

​
Description

The init command has two subcommands:

  • repo: Initializes a git repository for use with Ocuroot by creating a repo.ocu.star file at the root of the repository.
  • package [path]: Initializes a package at the specified path by creating a package.ocu.star file with templated functions.

Both commands require you to be inside a git repository. If repo.ocu.star doesn’t exist when running init package, it will be created automatically, so your project is ready to use right away!

​
Examples

# Initialize the current repository
ocuroot init repo

# Initialize a package in the current directory
ocuroot init package .

# Initialize a package at a specific path
ocuroot init package path/to/package

​
Output

​
init repo

The command creates a repo.ocu.star file at the root of your git repository. The repository ID is automatically derived from your git remote URL.

Example file content:

load("github.com/ocuroot/sdk/v0/repo.star", "repo")

repo(id="github.com/user/repository")

​
init package

The command creates a package.ocu.star file at the specified path with templated functions for building, deploying, and destroying your package:

Example file content:

load("github.com/ocuroot/sdk/v0/package.star", "package")
load("github.com/ocuroot/sdk/v0/machine.star", "host")
load("github.com/ocuroot/sdk/v0/policy.star", "ready", "skip", "dependency")

def policy(ctx):
    # Return ready when the package is ready to be deployed
    # Modify this according to your specific requirements
    return ready()

def build(ctx):
    # Build function for the package
    host.shell("echo Building my-package package...")

def deploy(ctx):
    # Deploy function for the package
    host.shell("echo Deploying my-package package...")

def destroy(ctx):
    # Destroy function for the package
    host.shell("echo Destroying my-package package...")

package(
    name="my-package",
    policy=policy,
    build=build,
    deploy=deploy,
    destroy=destroy
)

The package name is automatically set to the directory name where the package is being initialized.

  • build: Run the build function for a package
  • packages: List all packages in the current repository