End-User Guide

Bootstrapping a Project

Generate starter asset and input files for a new project using a module's bootstrap configuration.

Bootstrapping a Project

When starting a new project that uses an existing module, the rescile-ce bootstrap command provides a convenient way to generate the necessary starter asset and input files.

This command reads the module.toml manifest from the specified module and uses the bootstrap content defined within the [assets] and [inputs] sections to create the initial files in your local data directory.

bootstrap Configuration

Add a bootstrap key to your [assets] or [inputs] definition containing a multiline string of starter content:

[assets."application.csv"]
description = "The main asset file defining the applications."
bootstrap = """
name,owner
myapp,"team-awesome"
"""

[inputs."config.json"]
format = "object_of_objects"
bootstrap = """
{
  "dev": {
    "replicas": 1,
    "cpu": "500m"
  }
}
"""

Using the Bootstrap Command

Run the bootstrap command with the remote or local module you want to initialize from:

# Bootstrap a new project in the current directory using a remote module
rescile-ce --module https://github.com/my-org/rescile-modules/standard-webapp bootstrap

This allows a user to quickly set up the required data structure for a module and start populating it with their project-specific information, significantly speeding up project initialization.