{"id":18633259,"url":"https://github.com/sstallion/vimwiki-cli","last_synced_at":"2025-07-01T06:34:12.560Z","repository":{"id":58601023,"uuid":"359282535","full_name":"sstallion/vimwiki-cli","owner":"sstallion","description":"Vimwiki Command-Line Interface","archived":false,"fork":false,"pushed_at":"2024-02-12T18:44:27.000Z","size":74,"stargazers_count":18,"open_issues_count":6,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-20T05:04:25.642Z","etag":null,"topics":["cli","vim","vimwiki","wiki"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sstallion.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-19T00:25:32.000Z","updated_at":"2024-12-11T17:06:10.000Z","dependencies_parsed_at":"2025-04-11T14:52:59.814Z","dependency_job_id":"66b4e58f-584f-4b8b-8ed3-4a3b2bb0b026","html_url":"https://github.com/sstallion/vimwiki-cli","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.06666666666666665,"last_synced_commit":"fbd6eb6ba24972c680cea08df69cbd1c7367a328"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/sstallion/vimwiki-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sstallion","download_url":"https://codeload.github.com/sstallion/vimwiki-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sstallion%2Fvimwiki-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262914088,"owners_count":23383826,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","vim","vimwiki","wiki"],"created_at":"2024-11-07T05:14:42.763Z","updated_at":"2025-07-01T06:34:12.527Z","avatar_url":"https://github.com/sstallion.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vimwiki Command-Line Interface\n\n[![](https://github.com/sstallion/vimwiki-cli/actions/workflows/ci.yml/badge.svg?branch=master)][1]\n[![](https://img.shields.io/pypi/v/vimwiki-cli)][2]\n[![](https://img.shields.io/pypi/pyversions/vimwiki-cli)][2]\n[![](https://img.shields.io/github/license/sstallion/vimwiki-cli)][3]\n\n`vimwiki-cli` is a command-line interface to [Vimwiki][4], a plugin for the\n[Vim][5] text editor. It provides a front-end for interactive editor commands\nand can be used to automate repetitive tasks such as rebuilding tag metadata and\ngenerating links, all from the command line.\n\n[![](https://asciinema.org/a/413921.svg)](https://asciinema.org/a/413921?autoplay=1)\n\n## Installation\n\n`vimwiki-cli` is available on [PyPI][2] and can be installed locally using the\nPython Package Installer:\n\n    $ python -m pip install --user vimwiki-cli\n\nOnce installed, issue `vimwiki --help` to see usage.\n\n## Configuration\n\nFor most installations no configuration is needed, however several environment\nvariables are available to modify default behavior without the need to pass\nglobal options on the command line:\n\n| Environment Variable   | Global Option    | Description                                       |\n| ---------------------- | ---------------- | ------------------------------------------------- |\n| `VIMWIKI_EDITOR`       | `--editor`       | Editor to launch, defaults to `$EDITOR` or `vim`. |\n| `VIMWIKI_COUNT`        | `--count`        | Index of wiki to open.                            |\n| `VIMWIKI_SELECT`       | `--select`       | Select wiki from interactive list.                |\n| `VIMWIKI_OPEN_MATCHES` | `--open-matches` | Open search results by default.                   |\n| `VIMWIKI_OPEN_TABS`    | `--open-tabs`    | Open pages in a new tab by default.               |\n\n## Advanced\n\n### Supported Commands\n\nEach CLI command corresponds to one or more Ex commands executed in the editor.\nThe following table details the mapping between these commands:\n\n| CLI Command                             | Ex Commands                                                         |\n| --------------------------------------- | ------------------------------------------------------------------- |\n| `vimwiki`                               | `:VimwikiIndex`                                                     |\n| `vimwiki all-html`                      | `:VimwikiIndex \\| VimwikiAll2HTML`                                  |\n| `vimwiki check-links`                   | `:VimwikiIndex \\| VimwikiCheckLinks`                                |\n| `vimwiki diary`                         | `:VimwikiDiaryIndex`                                                |\n| `vimwiki diary generate-links`          | `:VimwikiDiaryIndex \\| VimwikiDiaryGenerateLinks`                   |\n| `vimwiki diary today`                   | `:VimwikiMakeDiaryNote`                                             |\n| `vimwiki diary tomorrow`                | `:VimwikiMakeTomorrowDiaryNote`                                     |\n| `vimwiki diary yesterday`               | `:VimwikiMakeYesterdayDiaryNote`                                    |\n| `vimwiki generate-links PAGE PATTERN`   | `:VimwikiIndex \\| VimwikiGoto PAGE \\| VimwikiGenerateLinks PATTERN` |\n| `vimwiki goto PAGE`                     | `:VimwikiIndex \\| VimwikiGoto PAGE`                                 |\n| `vimwiki help`                          | `:help vimwiki.txt \\| only`                                         |\n| `vimwiki search PATTERN`                | `:VimwikiIndex \\| VimwikiSearch PATTERN`                            |\n| `vimwiki tags generate-links PAGE TAGS` | `:VimwikiIndex \\| VimwikiGoto PAGE \\| VimwikiGenerateTagLinks TAGS` |\n| `vimwiki tags rebuild`                  | `:VimwikiIndex \\| VimwikiRebuildTags`                               |\n| `vimwiki tags search PATTERN`           | `:VimwikiIndex \\| VimwikiSearchTags PATTERN`                        |\n\n### Shell Completion\n\nShell completion is available for `bash`, `fish`, and `zsh` shells. To generate\nan activation script, issue:\n\n    $ env _VIMWIKI_COMPLETE=source_$(basename $SHELL) vimwiki \u003e/path/to/vimwiki-complete.sh\n\nOnce generated, the activation script may be sourced directly or from the shell\nstartup file to provide completion:\n\n    $ . /path/to/vimwiki-complete.sh\n\n### Git Integration\n\nFor wikis managed with Git, a pre-commit hook script is available that executes\nnon-interactive commands to rebuild tag metadata and generate links before\ncommit.\n\nThe pre-commit hook relies on the following configuration options:\n\n| Configuration Option         | Description                                    |\n| ---------------------------- | ---------------------------------------------- |\n| `vimwiki.options`            | Extra options to pass to the `vimwiki` command |\n| `vimwiki.linkspage`          | Page which contains generated links            |\n| `vimwiki.taglinkspage`       | Page which contains generated tag links        |\n| `vimwiki.generatelinks`      | Generate links before commit (bool)            |\n| `vimwiki.generatediarylinks` | Generate diary links before commit (bool)      |\n| `vimwiki.generatetaglinks`   | Generate tag links before commit (bool)        |\n| `vimwiki.rebuildtags`        | Rebuild tag metadata before commit (bool)      |\n| `vimwiki.allhtml`            | Convert wiki to HTML before commit (bool)      |\n\nFor example, to configure the hook to rebuild tag metadata and generate tag\nlinks in the `Tags` page before commit, issue:\n\n    $ git config vimwiki.taglinkspage Tags\n    $ git config vimwiki.generatetaglinks true\n    $ git config vimwiki.rebuildtags true\n\nTo enable the hook, copy or link [pre-commit.sh][6] to `.git/hooks/pre-commit`\nin the wiki directory. Alternatively, if [pre-commit][8] is installed, add a\n`pre-commit` configuration file, `.pre-commit-config.yaml` and run\n`pre-commit autoupdate` to enable the latest version of the hook.\n\n```yaml\n# See https://pre-commit.com for more information\n# See https://pre-commit.com/hooks.html for more hooks\nrepos:\n  - repo: https://github.com/sstallion/vimwiki-cli\n    rev: v1.1.0\n    hooks:\n      - id: vimwiki-cli\n```\n\n## Contributing\n\nPull requests are welcome! See [CONTRIBUTING.md][7] for more details.\n\n## License\n\nSource code in this repository is licensed under a Simplified BSD License. See\n[LICENSE][3] for more details.\n\n[1]: https://github.com/sstallion/vimwiki-cli/actions/workflows/ci.yml\n[2]: https://pypi.org/project/vimwiki-cli/\n[3]: https://github.com/sstallion/vimwiki-cli/blob/master/LICENSE\n[4]: https://vimwiki.github.io/\n[5]: https://www.vim.org/\n[6]: https://github.com/sstallion/vimwiki-cli/blob/master/scripts/pre-commit.sh\n[7]: https://github.com/sstallion/vimwiki-cli/blob/master/CONTRIBUTING.md\n[8]: https://pre-commit.com/index\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsstallion%2Fvimwiki-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsstallion%2Fvimwiki-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsstallion%2Fvimwiki-cli/lists"}