- restyle(1)
- Restyler v0.0.0.0
- restyle(1)
NAME
restyle - restyle local files
SYNOPSIS
restyle [--config-file=FILE_PATH] (--[no-]dry-run) (--[no-]fail-on-differences) [--restylers-version=TAG] [--manifest=FILE_PATH] [--exclude=GLOB[,GLOB]] [--also-exclude=GLOB[,GLOB]] [--ignore-authors=GLOB[,GLOB]] [--ignore-branches=GLOB[,GLOB]] [--ignore-labels=GLOB[,GLOB]] () () () [--host-directory=DIRECTORY_PATH] (--[no-]image-cleanup) (--[no-]pull) (--restyler-[no-]net-none) [--restyler-cpu-shares=NUMBER] [--restyler-memory=NUMBER<b|k|m|g>] (--restyler-[no-]restricted) (--[no-]commit) (--[no-]clean) (--[no-]debug) (--[no-]trace) [--color=WHEN] () PATH [PATH]
OPTIONS
-
--config-file=FILE_PATH
- Path to the configuration file
--[no-]dry-run- Do everything except pull and run restylers
--[no-]fail-on-differences- Exit non-zero if differences were found
-
--restylers-version=TAG
- Version of Restylers manifest to use
Ignored if manifest is given
(default "stable")
-
--manifest=FILE_PATH
- Restylers manifest to use
-
--exclude=GLOB[,GLOB]
- Exclude paths matching the given globs (instead of defaults)
By default, we ignore directories that are often checked-in but
rarely represent project code. Some globs are slightly complicated
match paths within directories of names appearing at any depth.
(default ["/.patch","**/.git/**/","/node_modules//","**/vendor/**/",".github/workflows//*"])
-
--also-exclude=GLOB[,GLOB]
- Exclude paths matching the given globs (in addition to defaults) (default [])
-
--ignore-authors=GLOB[,GLOB]
- Ignore authors that match globs (default ["*[bot]"])
-
--ignore-branches=GLOB[,GLOB]
- Ignore branches that match globs (default ["renovate/*"])
-
--ignore-labels=GLOB[,GLOB]
- Ignore labels that match globs (default ["restyled-ignore"])
-
--host-directory=DIRECTORY_PATH
- Working directory on host, if dockerized (default ".")
--[no-]image-cleanup- Remove images after running them
--[no-]pull- Explicitly pull images before running them
--restyler-[no-]net-none- Run restylers with --net=none
-
--restyler-cpu-shares=NUMBER
- Run restylers with --cpu-shares (default 512)
-
--restyler-memory=NUMBER<b|k|m|g>
- Run restylers with --memory (default 128m)
--restyler-[no-]restricted- Restrict restylers resources
--[no-]commit- Commit each restyling change
--[no-]clean- Run git-clean after restyling
--[no-]debug- Enable debug logging
--[no-]trace- Enable trace logging
-
--color=WHEN
- Enable color WHEN (default auto)
PATH- Path to restyle
PATH- Path to restyle
ENVIRONMENT
-
CONFIG_FILE=FILE_PATH
- Path to the configuration file
-
DRY_RUN=BOOL
- Do everything except pull and run restylers
-
FAIL_ON_DIFFERENCES=BOOL
- Exit non-zero if differences were found
-
RESTYLERS_VERSION=TAG
- Version of Restylers manifest to use
Ignored if manifest is given
-
MANIFEST=FILE_PATH
- Restylers manifest to use
-
EXCLUDE=GLOB[,GLOB]
- Exclude paths matching the given globs (instead of defaults)
By default, we ignore directories that are often checked-in but
rarely represent project code. Some globs are slightly complicated
match paths within directories of names appearing at any depth.
-
ALSO_EXCLUDE=GLOB[,GLOB]
- Exclude paths matching the given globs (in addition to defaults)
-
IGNORE_AUTHORS=GLOB[,GLOB]
- Ignore authors that match globs
-
IGNORE_BRANCHES=GLOB[,GLOB]
- Ignore branches that match globs
-
IGNORE_LABELS=GLOB[,GLOB]
- Ignore labels that match globs
-
HOST_DIRECTORY=DIRECTORY_PATH
- Working directory on host, if dockerized
-
IMAGE_CLEANUP=BOOL
- Remove images after running them
-
PULL=BOOL
- Explicitly pull images before running them
-
RESTYLER_NET_NONE=BOOL
- Run restylers with --net=none
-
RESTYLER_CPU_SHARES=NUMBER
- Run restylers with --cpu-shares
-
RESTYLER_MEMORY=NUMBER<b|k|m|g>
- Run restylers with --memory
-
RESTYLER_RESTRICTED=BOOL
- Restrict restylers resources
-
COMMIT=BOOL
- Commit each restyling change
-
CLEAN=BOOL
- Run git-clean after restyling
-
DEBUG=BOOL
- Enable debug logging
-
TRACE=BOOL
- Enable trace logging
-
COLOR|LOG_COLOR=WHEN
- Enable color WHEN
-
GITHUB_ACTIONS=true
- The value "true" if running on GitHub Actions
FILES
.restyled.yaml- Configuration for Restyled, see restyled.yaml(5)
SEE ALSO
docker(1), git(1), restyled.yaml(5)