Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.46 KB

dialects.md

File metadata and controls

70 lines (52 loc) · 2.46 KB
title rootform add dialects
description Add Dialects to rootform.lock

Add Dialects to rootform.lock.

Usage

rootform add dialects <source>... [options]

Options

Flag Type Default Description
--dry-run bool false print the planned change and write nothing
--format string "" output format: text|json; default: text
--offline bool false use no network; accept local and installed sources
--project string "" change rootform.lock and vendored copies in project dir; paths stay relative to the working directory; default: the working directory
--replace bool false replace the embedded Dialect with the same owner

Global options

Flag Type Default Description
-h, --help bool false show how to use rootform add dialects
--color mode auto color human output: auto|always|never; default: auto
--no-pager bool false print a long report in full instead of opening it in less

Behavior

Add Dialects to rootform.lock. Each source is a local directory (./path), a registry reference with a tag or digest, or the owner of an embedded Dialect that the project excluded.

Rootform compiles and verifies every source, records its exact identity, and writes rootform.lock once, or not at all. A registry source is installed in the Rootform home. A tag is resolved once and never recorded.

A Dialect whose owner is embedded in Rootform replaces the embedded one only with --replace.

When the project vendors this family under .rootform/, the vendored copy changes together with rootform.lock.

The summary goes to standard output. Diagnostics go to standard error.

Exit status

Status Description
0 rootform.lock matches the request
1 a source is invalid or a named selection is absent
2 the command was used incorrectly
3 rootform.lock is invalid, selections conflict, or --offline needs content that is not installed
4 a file, Rootform home, or network operation failed

Examples

rootform add dialects ./dialects/payments
rootform add dialects \
  registry.example.com/acme/dialects:dialect-payments-0.1.0
rootform add dialects ./dialects/aws --replace