| Name | check-symlinks JSON |
| Version |
0.5.3
JSON |
| download |
| home_page | None |
| Summary | Check for broken symlinks |
| upload_time | 2025-08-19 10:39:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2025 Jamison Lahman Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ci
continuous-integration
linter
symlinks
tooling
tools
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Check Symlinks
[](https://github.com/jmelahman/check-symlinks/actions)
[](https://github.com/jmelahman/check-symlinks/actions)
[](https://pkg.go.dev/github.com/jmelahman/check-symlinks)
[](https://aur.archlinux.org/packages/check-symlinks)
[](https://pypi.org/project/check-symlinks/)
[](https://goreportcard.com/report/github.com/jmelahman/check-symlinks)
Check for broken symbolic links.
```shell
$ check-symlinks
Broken symlink: some/path/broken_link
```
`check-symlinks` is optimized for large codebases as well as small, incremental checks,
<p align="center">
<picture align="center">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/jmelahman/check-symlinks/assets/23436978/b6d5a6f1-d3ec-4786-a234-92840ec26fc4">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/jmelahman/check-symlinks/assets/23436978/5619ff9a-474b-4daa-a179-d8f6d8f046a5">
<img alt="Shows a bar chart with benchmark results." src="https://github.com/jmelahman/check-symlinks/assets/23436978/5619ff9a-474b-4daa-a179-d8f6d8f046a5">
</picture>
</p>
where the full commands are respectively,
```shell
fd --type symlink --exec sh -c 'test -e "$0"'
check-symlinks
git ls-files | xargs pre_commit_hooks/check_symlinks.py
while read file; do test -e "$test"; done < <(git ls-files)
find . -type l -not -path data ! -exec test -e {} \; -print0 | xargs --no-run-if-empty git ls-files
```
and `check_symlinks.py` is from [https://github.com/pre-commit/pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks/blob/main/pre_commit_hooks/check_symlinks.py).
## Install
**AUR:**
`check-symlinks` is available from the [Arch User Repository](https://aur.archlinux.org/packages/check-symlinks).
```shell
yay -S check-symlinks
```
**pip:**
`check-symlinks` is available as a [pypi package](https://pypi.org/project/check-symlinks/).
```shell
pip install check-symlinks
```
**go:**
```shell
go install github.com/jmelahman/check-symlinks@latest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "check-symlinks",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "ci, continuous-integration, linter, symlinks, tooling, tools",
"author": null,
"author_email": "Jamison Lahman <jamison@lahman.dev>",
"download_url": null,
"platform": null,
"description": "# Check Symlinks\n\n[](https://github.com/jmelahman/check-symlinks/actions)\n[](https://github.com/jmelahman/check-symlinks/actions)\n[](https://pkg.go.dev/github.com/jmelahman/check-symlinks)\n[](https://aur.archlinux.org/packages/check-symlinks)\n[](https://pypi.org/project/check-symlinks/)\n[](https://goreportcard.com/report/github.com/jmelahman/check-symlinks)\n\nCheck for broken symbolic links.\n\n```shell\n$ check-symlinks\nBroken symlink: some/path/broken_link\n```\n\n`check-symlinks` is optimized for large codebases as well as small, incremental checks,\n\n<p align=\"center\">\n <picture align=\"center\">\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/jmelahman/check-symlinks/assets/23436978/b6d5a6f1-d3ec-4786-a234-92840ec26fc4\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://github.com/jmelahman/check-symlinks/assets/23436978/5619ff9a-474b-4daa-a179-d8f6d8f046a5\">\n <img alt=\"Shows a bar chart with benchmark results.\" src=\"https://github.com/jmelahman/check-symlinks/assets/23436978/5619ff9a-474b-4daa-a179-d8f6d8f046a5\">\n </picture>\n</p>\n\nwhere the full commands are respectively,\n\n```shell\nfd --type symlink --exec sh -c 'test -e \"$0\"'\n\ncheck-symlinks\n\ngit ls-files | xargs pre_commit_hooks/check_symlinks.py\n\nwhile read file; do test -e \"$test\"; done < <(git ls-files)\n\nfind . -type l -not -path data ! -exec test -e {} \\; -print0 | xargs --no-run-if-empty git ls-files\n```\n\nand `check_symlinks.py` is from [https://github.com/pre-commit/pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks/blob/main/pre_commit_hooks/check_symlinks.py).\n\n## Install\n\n**AUR:**\n\n`check-symlinks` is available from the [Arch User Repository](https://aur.archlinux.org/packages/check-symlinks).\n\n```shell\nyay -S check-symlinks\n```\n\n**pip:**\n\n`check-symlinks` is available as a [pypi package](https://pypi.org/project/check-symlinks/).\n\n```shell\npip install check-symlinks\n```\n\n**go:**\n\n```shell\ngo install github.com/jmelahman/check-symlinks@latest\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 Jamison Lahman Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Check for broken symlinks",
"version": "0.5.3",
"project_urls": {
"Repository": "https://github.com/jmelahman/check-symlinks"
},
"split_keywords": [
"ci",
" continuous-integration",
" linter",
" symlinks",
" tooling",
" tools"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3ae8d7e734d2c34679649f29e320bc8b03411230c92568c024318976d2370998",
"md5": "57bc38924cd8877c6b214c4300121491",
"sha256": "a3c7cc5022de46268ea16587db8a7463c4ebed1c39b942dd968a6bc26eebd8fd"
},
"downloads": -1,
"filename": "check_symlinks-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57bc38924cd8877c6b214c4300121491",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1058818,
"upload_time": "2025-08-19T10:39:08",
"upload_time_iso_8601": "2025-08-19T10:39:08.233260Z",
"url": "https://files.pythonhosted.org/packages/3a/e8/d7e734d2c34679649f29e320bc8b03411230c92568c024318976d2370998/check_symlinks-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e35cb2a8cc7f7a2245fc3e42578f237d4b5399d5550c2539abb0f15c8d431319",
"md5": "178918eef9898f3d05b72f7ebddd306f",
"sha256": "47437ed03f4fbcd3d33d6de6384bc4de5dceffc1d71e2e07571b057836f766fa"
},
"downloads": -1,
"filename": "check_symlinks-0.5.3-py3-none-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "178918eef9898f3d05b72f7ebddd306f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1020887,
"upload_time": "2025-08-19T10:39:05",
"upload_time_iso_8601": "2025-08-19T10:39:05.476077Z",
"url": "https://files.pythonhosted.org/packages/e3/5c/b2a8cc7f7a2245fc3e42578f237d4b5399d5550c2539abb0f15c8d431319/check_symlinks-0.5.3-py3-none-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "61ba04c571304c497df4e71f9cb1bacb43ae4bfb720ad206886b92cf461ab53a",
"md5": "b842527d7237cdbc436a498e67c4ae7d",
"sha256": "362f3f862c38c26ecd1b14b247754556b4e013f457028d07140998613cacbba9"
},
"downloads": -1,
"filename": "check_symlinks-0.5.3-py3-none-manylinux_2_17_aarch64.whl",
"has_sig": false,
"md5_digest": "b842527d7237cdbc436a498e67c4ae7d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 977333,
"upload_time": "2025-08-19T10:39:04",
"upload_time_iso_8601": "2025-08-19T10:39:04.093323Z",
"url": "https://files.pythonhosted.org/packages/61/ba/04c571304c497df4e71f9cb1bacb43ae4bfb720ad206886b92cf461ab53a/check_symlinks-0.5.3-py3-none-manylinux_2_17_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "548fba47034dcc2d1d1140e8965e5a0b6eb49e7db907f6563a31568c8b37a7ea",
"md5": "410df25ea2375b6aedf2a12d8dcf82c9",
"sha256": "307b7b512e9cd2fe08c46e8b873cf1847d009e2241b6b7c44431c62945c1dd9e"
},
"downloads": -1,
"filename": "check_symlinks-0.5.3-py3-none-manylinux_2_17_x86_64.whl",
"has_sig": false,
"md5_digest": "410df25ea2375b6aedf2a12d8dcf82c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1058835,
"upload_time": "2025-08-19T10:39:06",
"upload_time_iso_8601": "2025-08-19T10:39:06.532874Z",
"url": "https://files.pythonhosted.org/packages/54/8f/ba47034dcc2d1d1140e8965e5a0b6eb49e7db907f6563a31568c8b37a7ea/check_symlinks-0.5.3-py3-none-manylinux_2_17_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0aaf8c7e012587c712d95265029eb7581f417fb5792f68d60e1c9ffe1db0fc09",
"md5": "14f185851f9b5110b75360fb2b02ad1d",
"sha256": "76973a00fc9259fcda4c79dc5c4793688e7565d5e775f158acf92df3f256861a"
},
"downloads": -1,
"filename": "check_symlinks-0.5.3-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "14f185851f9b5110b75360fb2b02ad1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1163856,
"upload_time": "2025-08-19T10:39:07",
"upload_time_iso_8601": "2025-08-19T10:39:07.384253Z",
"url": "https://files.pythonhosted.org/packages/0a/af/8c7e012587c712d95265029eb7581f417fb5792f68d60e1c9ffe1db0fc09/check_symlinks-0.5.3-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "162b829138ab40b98f3c8caa59eab99996216e0315db0a944f866bb2e6a33f81",
"md5": "b768cf01d8dec36701bf2db2d4617938",
"sha256": "4c9b8f7912ee68baddaa91fdccef1109f9aa11adad2edd1fbd3cb05c04630121"
},
"downloads": -1,
"filename": "check_symlinks-0.5.3-py3-none-win_arm64.whl",
"has_sig": false,
"md5_digest": "b768cf01d8dec36701bf2db2d4617938",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1063177,
"upload_time": "2025-08-19T10:39:07",
"upload_time_iso_8601": "2025-08-19T10:39:07.248046Z",
"url": "https://files.pythonhosted.org/packages/16/2b/829138ab40b98f3c8caa59eab99996216e0315db0a944f866bb2e6a33f81/check_symlinks-0.5.3-py3-none-win_arm64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-19 10:39:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmelahman",
"github_project": "check-symlinks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "check-symlinks"
}
