Skip to content

restyled-io/restyler

Repository files navigation

Restyler

The restyling process, as a CLI.

Installation

curl --proto '=https' --tlsv1.2 -sSf \
  https://raw.githubusercontent.com/restyled-io/restyler/main/install | sudo sh

Usage

Usage: restyle [--debug] [--trace] [--color WHEN] [--fail-on-differences] 
               [--host-directory DIRECTORY] [--image-cleanup] [--manifest FILE] 
               [--no-commit] PATH [PATH]

  Restyle local files

Available options:
  --debug                  Enable debug logging
  --trace                  Enable trace logging
  --color WHEN             When to use color: always|never|auto
  --fail-on-differences    Exit non-zero if differences were found
  --host-directory DIRECTORY
                           Working directory on host, if dockerized
  --image-cleanup          Remove pulled restyler images after restyling
  --manifest FILE          Restylers manifest to use
  --no-commit              Don't make commits for restyle changes
  -h,--help                Show this help text

Available environment variables:
  FAIL_ON_DIFFERENCES
                         Exit non-zero if differences were
                         found
  HOST_DIRECTORY         Working directory on host, if
                         dockerized
  IMAGE_CLEANUP          Remove pulled restyler images
                         after restyling
  LOG_BREAKPOINT
  LOG_COLOR
  LOG_CONCURRENCY
  LOG_DESTINATION
  LOG_FORMAT
  LOG_LEVEL
  MANIFEST               Restylers manifest to use
  NO_COLOR
  NO_COMMIT              Don't make commits for restyle
                         changes
  RESTYLER_CPU_SHARES
                         Run restylers with
                         --cpu-shares=<number>
  RESTYLER_MEMORY        Run restylers with
                         --memory=<number>[b|k|m|g]
  RESTYLER_NO_NET_NONE
                         Run restylers without --net=none
  TERM
  UNRESTRICTED           Run restylers without CPU or
                         Memory restrictions

GitHub Actions

See https://github.com/restyled-io/actions#readme.

Development

just

Requires stack.

Tests

just test

LICENSE

Restyled is source-available, Commons Claused licensed. For a detailed description of another project's rationale for this licensing model, one with which I agree, see here.


CHANGELOG | LICENSE | CONTRIBUTING