Migrate system presets to v2

This page is for users maintaining custom v1 system presets. If you only use the system presets built into Shine 2, no manual migration is needed; see Initialize and manage a system.

Migration changes shine.toml and scripts in your preset directory, not installed software. Do not delete or manually rewrite the run records in ~/.shine/sys-manifest.toml.

The example below migrates a Neovim item in ./my-presets/sys/macos/. Replace this with your actual path. For Ubuntu, use sys/ubuntu/ and --platform linux; for Windows, use sys/windows/ and --platform windows. The example's Homebrew installation applies only to macOS.

1. Locate the preset to change

Before editing, preserve the old preset in version control or a separate copy, then inspect it:

shine preset migrate ./my-presets/sys/macos --dry-run

A sys_v1_manual_migration_required report with a nonzero exit code means you need to migrate manually using the steps below. Shine cannot automatically split the old init.sh or init.ps1 into individual installers; rerunning the migration command will not do that work.

If you do not know which preset is active, run shine preset migrate --dry-run and check the paths in its report. For a Shine-managed Git overlay, edit its upstream checkout rather than the local mirror.

2. Migrate one installation item first

Suppose a branch in the old init.sh calls brew install neovim. In v2, describe that installation directly in sys/macos/shine.toml:

version = 2
description = "My macOS development tools."
default_profile = "recommended"

[[items]]
id = "neovim"
label = "Neovim"
description = "Install Neovim with Homebrew."
permissions = { schema_version = 1 }

[items.detect]
kind = "command"
command = "nvim"
version_args = ["--version"]

[items.install]
kind = "package"
provider = "homebrew"
package = "neovim"

[profiles.recommended]
items = ["neovim"]

This is a complete example containing one item. When migrating an existing file, keep its other items and their IDs and convert them individually; do not replace the whole configuration with this example.

• detect tells Shine how to check whether software is present; here it checks the nvim command.
• install tells Shine how to install missing software. This example uses Homebrew, which must be available before the actual installation.
• permissions is required for every item. This example uses only a fixed package provider and no custom code, so the short declaration above is sufficient.
• [profiles.recommended] selects the items in that group. Check that IDs in existing groups still refer to valid items.

For Ubuntu or Windows, use the appropriate apt or winget provider and verify the actual package name in that package manager; do not assume the Homebrew package name also applies.

When installation needs a custom script

If a package manager cannot perform an item's installation, move its logic out of the old script into install/<item>.sh or install/<item>.ps1. Change that item's install to kind = "script", path = "install/<item>.sh" (use .ps1 for Windows).

The script handles only that item, reports success or failure with a normal exit code, and still needs a corresponding detect. Declare its executable path, commands, network access, and other required permissions based on what the script actually does. Do not reuse the example's schema_version-only declaration. See Declare permissions for the fields.

After converting every item, remove the old shared entry point and its old status-output and update-check logic. Third-party software updates belong to its package manager or upstream tool; shine sys bootstrap only ensures that software is installed.

3. Migrate shell configuration if needed

Skip this step if the old preset does not change shell configuration.

Move software-specific PATH entries, environment variables, aliases, or initialization commands into that item's [[items.shell]]. Longer scripts can live in profile/<item>.sh or .ps1 and be referenced through fragment. Keep only OS-wide content in profile/base.pre.* and profile/base.post.*.

See Author a system bootstrap item for forms and examples. Check that each software-specific integration belongs to its item and no longer runs a second time from a shared file.

4. Validate the local files

shine preset validate ./my-presets/sys/macos
shine preset plan ./my-presets/sys/macos --platform macos

First fix errors reported by validate, such as missing files, permission declarations, or invalid configuration. Then review the installation targets, required permissions, and shell configuration steps in plan and check that they match your intent.

Neither command installs software or executes preset scripts. preset plan uses a simulated environment, not your machine's installation state. Missing simulated trust, commands, or administrator conditions can also block its report. Distinguish configuration errors from environment requirements; do not broaden permissions just to make the report pass.

5. Make Shine use the migrated preset

If you edited the source already configured in Shine, no relinking is needed. If you migrated another checkout, choose the appropriate method below and pass the root containing sys/, not sys/macos/:

For a complete preset repository, select it as the external source:

shine preset link ./my-presets

For a repository overriding selected built-in presets, use the overlay instead:

shine preset overlay link ./my-presets

The chosen command replaces its corresponding source setting. For a Git-managed overlay, first publish the upstream changes to its configured branch, then run shine preset pull. See Custom presets for source configuration details.

On the target operating system, inspect the item Shine actually reads:

shine sys list
shine sys info neovim
shine sys bootstrap neovim --dry-run

Check that the list and details contain your migrated item and that the preview shows the intended installation command and shell configuration. If it still shows old content, check the source path and overlay overrides first.

The package-only example above does not need an additional code trust grant. If you added an external installer or executable shell content (eval, source, fragments, or shared profile scripts), review that code, then inspect and grant trust for the corresponding item:

shine trust inspect sys/neovim
shine trust grant sys/neovim

A permission declaration describes what a preset needs to do; a trust grant records your review and permission to execute its code. Changed code or permissions require a new review. Run the installation preview again after granting trust.

Migration preparation is complete when local validation has no errors, Shine reads the correct source, and the installation preview matches your intent. When ready to install, run shine sys bootstrap neovim and review the plan before confirming. Continue with Initialize and manage a system for everyday use.