Files
coder/docs/cli/dotfiles.md
T
Ammar Bandukwala dd97fe2bce chore(cli): replace lipgloss with coder/pretty (#9564)
This change will improve over CLI performance and "snappiness" as well as
substantially reduce our test times. Preliminary benchmarks show
`coder server --help` times cut from 300ms to 120ms on my dogfood
instance.

The inefficiency of lipgloss disproportionately impacts our system, as all help
text for every command is generated whenever any command is invoked.

The `pretty` API could clean up a lot of the code (e.g., by replacing
complex string concatenations with Printf), but this commit is too
expansive as is so that work will be done in a follow up.
2023-09-07 16:28:22 -05:00

47 lines
1.0 KiB
Markdown
Generated

<!-- DO NOT EDIT | GENERATED CONTENT -->
# dotfiles
Personalize your workspace by applying a canonical dotfiles repository
## Usage
```console
coder dotfiles [flags] <git_repo_url>
```
## Description
```console
- Check out and install a dotfiles repository without prompts:
$ coder dotfiles --yes git@github.com:example/dotfiles.git
```
## Options
### -b, --branch
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specifies which branch to clone. If empty, will default to cloning the default branch or using the existing branch in the cloned repo on disk.
### --symlink-dir
| | |
| ----------- | ------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SYMLINK_DIR</code> |
Specifies the directory for the dotfiles symlink destinations. If empty, will use $HOME.
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.