Commit graph

556 commits

Author SHA1 Message Date
Vladislav Doster fdcbb25688 docs(readme): document self-update --no-pager
Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2026-08-31 15:50:14 -05:00
onice b1176045f9
docs: document compile execution order (#789) 2026-07-18 05:04:36 -05:00
vladdoster 8f89f88cfd feat(zsh): allow configuring settings like HOME_DIR/BIN_DIR via zstyle
Resolve ZINIT[...] settings from `zstyle ':zinit:config' <attr>` before
the BIN_DIR/HOME_DIR/derived-dir logic runs. The attribute name is the
hash field lowercased with `_` replaced by `-` (HOME_DIR -> home-dir).

An explicitly-set ZINIT[KEY] always wins over zstyle, which wins over
the built-in default; fully backward-compatible.

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2026-06-18 19:05:42 -05:00
Andrea Alberti 4205b399dd
docs: improve documentation of extract modifiers (their documentation was so far completely missing) 2026-03-06 01:15:30 +01:00
Vladislav Doster 507b4e5722 fix: add markdownlint exceptions to linting
Disabled following checks:

- MD024/no-duplicate-heading
- MD059/descriptive-link-text
- MD060/table-column-style

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2026-02-02 10:50:22 -06:00
vladislav doster 9f3703176a
docs(README.md): fix typos 2025-10-02 22:34:41 -05:00
Junior Nascimento c84533b4ce
docs: Add async_prompt.zsh to OMZ theme migration guide (#727) 2025-07-23 10:46:11 +02:00
Philipp Schmitt 2daaac2de2
Fix #719 (#722) 2025-06-07 15:22:07 +02:00
Björn Richter 25c18b5b2a
docs: Add instructions for how to disable global compinit on NixOS (#717) 2025-04-25 21:47:14 +02:00
Philipp Schmitt b096d6ef53
Fix tables in README
Some checks failed
Container images / build-containers-with-zsh (5.2.4) (push) Has been cancelled
Container images / build-containers-with-zsh (5.3.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.4.2) (push) Has been cancelled
Container images / build-containers-with-zsh (5.5.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.6.2) (push) Has been cancelled
Container images / build-containers-with-zsh (5.7.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.8) (push) Has been cancelled
Container images / build-containers-with-zsh (5.9) (push) Has been cancelled
Lint / Markdown Lint (push) Has been cancelled
Container images / build-container-latest (push) Has been cancelled
Documentation / zshelldoc (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, annexes) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, commands) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, compile) (push) Has been cancelled
Lint / ZSH Lint (zsh-noexec) (push) Has been cancelled
Lint / ZSH Lint (zsh-zcompile) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, gh-r) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, ices) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, plugins) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, snippets) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, annexes) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, commands) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, compile) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, gh-r) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, ices) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, plugins) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, snippets) (push) Has been cancelled
- Revert "lint: fmt README.md (#694)" (#695)
- Switch to markdownlint
- Fix markdown linting issues
2025-01-28 18:01:31 +01:00
Philipp Schmitt f654c77ef1
lint: fmt README.md (#694)
Some checks failed
Container images / build-container-latest (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, annexes) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, commands) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, compile) (push) Has been cancelled
Container images / build-containers-with-zsh (5.2.4) (push) Has been cancelled
Container images / build-containers-with-zsh (5.3.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.4.2) (push) Has been cancelled
Container images / build-containers-with-zsh (5.5.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.6.2) (push) Has been cancelled
Container images / build-containers-with-zsh (5.7.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.8) (push) Has been cancelled
Container images / build-containers-with-zsh (5.9) (push) Has been cancelled
Documentation / zshelldoc (push) Has been cancelled
Lint / Lint (markdown) (push) Has been cancelled
Lint / Lint (zsh-noexec) (push) Has been cancelled
Lint / Lint (zsh-zcompile) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, gh-r) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, ices) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, plugins) (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest, snippets) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, annexes) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, commands) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, compile) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, gh-r) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, ices) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, plugins) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest, snippets) (push) Has been cancelled
2025-01-26 10:14:29 +01:00
Joseph Lee 1e60350e75
docs: fix a few words (#688)
Some checks failed
Container images / build-containers-with-zsh (5.2.4) (push) Has been cancelled
Container images / build-containers-with-zsh (5.3.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.4.2) (push) Has been cancelled
Container images / build-containers-with-zsh (5.5.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.6.2) (push) Has been cancelled
Container images / build-containers-with-zsh (5.7.1) (push) Has been cancelled
Container images / build-containers-with-zsh (5.8) (push) Has been cancelled
Container images / build-containers-with-zsh (5.9) (push) Has been cancelled
Container images / build-container-latest (push) Has been cancelled
Documentation / zshelldoc (push) Has been cancelled
Lint / Lint (push) Has been cancelled
Unit Tests / zunit-tests (macos-latest) (push) Has been cancelled
Unit Tests / zunit-tests (ubuntu-latest) (push) Has been cancelled
2025-01-20 08:56:30 +01:00
vladislav doster b7b8347cad
fix: compile command logic when using id-as ice (#619)
- Updated README.md `compiling` section
- Compile commands now work with `id-as` ice
- Compile command options added to tab completion  

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2024-03-03 23:43:48 -06:00
vladislav doster e458e8288e
refactor: clist subcommand renamed to completions (#583)
Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2023-09-30 18:46:19 -05:00
vladislav doster b456a2dba6
fix: self-update check for updates (#562)
Signed-off-by: Doster, Vladislav <mvdoster@gmail.com>
2023-08-28 04:17:59 -05:00
Sebastian Gniazdowski fe8064a391 docs: document $ZPFX variable in README 2023-08-21 13:50:51 -05:00
Vladislav Doster a86590762a
feat: refactor ls, list, and loaded commands
Issues addressed:

1. Confusing and unintuitive command names

  Currently, two commands `loaded` and `list` will list installed
  plugins and a single command `ls` lists installed snippets. The namea
  don't make much sense or give context to their behavior, nor does
  having two commands with identical behavior.

This PR removes the three commands in favor of two new commands
`list-snippets` and `list-plugins`. The names align with the action they
perform.

2. Uninformative output

  Current output is hard to grok.

This PR cleans up the output format and uses color to help convey
information.

3. Incorrect

  Output does not account for various situations with the only way to
  fix is to reload Zsh session which would not always fix it. See images
  below for the aforementioned situations.

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2023-04-09 21:45:15 -05:00
Ryoga c624ac0077
add an option to disable aliases (#452)
* feat: add option to disable aliases

* docs: add docs for `ZINIT[NO_ALIASES]`
2023-03-26 22:54:30 +02:00
Qiming Xu 4933b62f40
fix: the starship example does not work properly 2023-02-24 12:21:53 +08:00
Michael Bianco 5e1c79cb22
Add conditional directory and git cloning calls to setup instructions
Without this, you'll get an error on each terminal startup.
2023-01-03 08:38:43 -07:00
Vladislav Doster bfb01e65d7 feat: display version via version sub command
Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2022-12-17 06:14:46 -06:00
Jan Katins 59975d70d7
feat: add completions ice (#417)
This can be used to overwrite `as'null'`, which would otherwise not trigger
completion detection and installation.

It will override the `nocompletions` ice when both are specified (e.g., using
the default ice annex).
2022-12-05 07:21:28 -06:00
Vladislav Doster 8a75a56ce5 style: format README.md to linter standards
Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2022-10-30 07:58:03 -05:00
Sebastian Gniazdowski 061a85c4ff
Add support for multiple (cmake, scons, meson) build systems to the configure'' ice. (#351) 2022-09-27 19:54:11 -05:00
vladislav doster 3153146cdc
docs: format README.md (#347)
- Fixes failing markdown linting test

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2022-07-17 22:03:21 -05:00
Sebastian Gniazdowski 40a46c6d22
feat: add configure"" ice (#334)
### configure ice

The new `configure''` ice is a facade for the following code.

```zsh
atclone'./configure --prefix=$PWD'
atpull'%atclone'
```

### Example:

Without the `configure` ice:

```zsh
zi for \
    as'null' \
    atclone'autoreconf -iv && ./configure --prefix=$PWD' \
    atpull'%atclone' \
    lbin'!**/stow' \
    make'PREFIX=$PWD install' \
    nocompile \
  @aspiers/stow
```

With the `configure` ice:

```zsh
zi for \
    as'null' \
    configure'#' \
    lbin'!**/stow' \
    make'PREFIX=$PWD install' \
    nocompile \
  @aspiers/stow
```

Additionally, passing `#` as the ice value will look for and run `autogen.sh` prior to running `./configure`.
2022-07-16 22:56:25 -05:00
Tony Narlock 87da39ec15
docs(README): Fix migration link 2022-05-24 17:35:12 -05:00
Tommy Wang b6f286b2c7
Add a new ice named "link", enabling local snippets to be symlinked instead of copied into the cache. (#234)
* Add link ice for local-only snippets that uses symlink instead of copying
* update docs
* fix README for link ice
* fix unit tests for link ice
- account for the host not having `realpath` >= 8.23 (the symlink will be
  an absolute path instead of a relative path)
2022-05-07 18:06:46 -05:00
vladislav doster 630f21f167
docs: remove git.io URL use from install command (#230)
Closes #229

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2022-04-26 15:19:20 -05:00
vladislav doster 450d3c10a8
feat: add -a (actual time) to zinit times cmd (#223)
- Display load moments to `zinit times` via new `-a` flag.

I found it useful to show both plugin load times, as well as load moments:

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2022-04-25 01:36:25 -05:00
vladislav doster bad7af3ae2
feat: ability to set program for zinit ls to use (#221)
A user can now specify a program via the `$ZINIT[LIST_COMMAND]`
variable. Additionally, it will first check for `exa` and fallback to
tree if this variable is not set.

e.g., use exa or any `tree`-esque program in `zinit ls`.

Closes #170

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2022-04-25 01:00:47 -05:00
vladislav doster fa269b4312
docs: update README.md install command to use bash to avoid error (#218)
Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2022-04-24 06:25:34 -05:00
Vladislav Doster 96fe03f85b feat: expand linted file types to markdown and shell
Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
2022-04-17 17:26:08 -05:00
Philipp Schmitt 6b28299ce2
zinit-annex-as-monitor -> zinit-annex-readurl 2021-12-01 08:56:56 +01:00
Philipp Schmitt d82c6133ae
Update wiki links 2021-12-01 08:46:15 +01:00
Philipp Schmitt fa16e90034 Leverage the ver ice to install from a specific branch or commit 2021-11-29 09:53:12 +01:00
Philipp Schmitt 8dc5641f8a
Shorten install url 2021-11-21 09:03:18 +01:00
Philipp Schmitt fddfb49c91
Add zunit test badge 2021-11-20 21:24:23 +01:00
Aaron Lichtman 253df67c4c
Merge pull request #89 from zdharma-continuum/update-manpage
📚 Update manpage, zsd, README TOC and add instructions for docs
2021-11-20 01:18:27 -06:00
Philipp Schmitt 59f45f1bbe
Update TOC 2021-11-20 00:01:25 +01:00
Philipp Schmitt ad9f5e7195
Remove dead link (NEWS is gone) 2021-11-19 13:03:31 +01:00
Aaron Lichtman 9d87127555
Fix URL 2021-11-18 05:22:51 -06:00
Philipp Schmitt 2bda700a91
Merge branch 'master' into zinit-package-monorepo 2021-11-18 12:11:48 +01:00
Philipp Schmitt 8816c52552
Update TOC 2021-11-18 08:37:32 +01:00
Philipp Schmitt cd2a5f1f96
zinit-packages monorepo - Fix #69 2021-11-18 07:56:43 +01:00
Philipp Schmitt 3020177e1c
✂️ Relocate module 2021-11-17 22:10:13 +01:00
Philipp Schmitt e6c48ac214
Fix install.sh URL (don't hardcode the branch name) 2021-11-16 08:25:56 +01:00
Philipp Schmitt 3d8ac200a9
XDG-ify ZINIT_HOME 2021-11-15 21:41:12 +01:00
Philipp Schmitt 32d67c4f3d
Move mod-install.sh to scripts/ 2021-11-15 20:09:24 +01:00
Philipp Schmitt ac892821ba
Update default paths 2021-11-15 20:07:31 +01:00