Initialize a project

The init command generates starter configuration files for your Upsun project.

Usage

upsun init

When you run upsun init, you can choose how to generate your starter configuration files. You can either:

• Use AI to analyze your project and generate a configuration automatically.
• Follow a guided setup, which does not use AI.

AI configuration

The AI option analyzes the repository locally and sends a sanitized “digest” to the Upsun API, which then contacts our AI provider.

You can view the repository digest by running upsun init --digest. The digest contains:

• tree: a concise list of the files in the repository
• reports: a list of findings for each directory in the repository, including identified frameworks or build tools
• selected_files: the contents of a few files that look particularly relevant for configuration, including README.md and Dockerfile

At this time, OpenAI is the provider used for all configuration generation.

Privacy

The selected files whose contents are included in the repository digest are chosen to be unlikely to include sensitive information.

The file contents are sanitized locally before being sent to the Upsun API. Upsun redacts email addresses and common secrets identified by using gitleaks.

Output

For both the AI and non-AI processes, the expected result is valid YAML. In many cases, the result is an acceptable starter configuration for the project.

Both the AI and non-AI processes create an .upsun/config.yaml file in your project root. This config file contains:

• Application configuration (see the App reference)
• Service definitions (see Add services)
• Route configurations (see Define routes)

After running upsun init, you can deploy your project as follows:

git add .upsun/config.yaml
git commit -m 'Add Upsun configuration'
upsun project:set-remote
upsun push

init command options