lucidshark 0.5.15__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of lucidshark might be problematic. Click here for more details.

Files changed (97) hide show
  1. lucidshark-0.5.15/LICENSE +201 -0
  2. lucidshark-0.5.15/PKG-INFO +247 -0
  3. lucidshark-0.5.15/README.md +205 -0
  4. lucidshark-0.5.15/pyproject.toml +135 -0
  5. lucidshark-0.5.15/setup.cfg +4 -0
  6. lucidshark-0.5.15/src/lucidshark/__init__.py +12 -0
  7. lucidshark-0.5.15/src/lucidshark/bootstrap/__init__.py +26 -0
  8. lucidshark-0.5.15/src/lucidshark/bootstrap/paths.py +160 -0
  9. lucidshark-0.5.15/src/lucidshark/bootstrap/platform.py +111 -0
  10. lucidshark-0.5.15/src/lucidshark/bootstrap/validation.py +76 -0
  11. lucidshark-0.5.15/src/lucidshark/bootstrap/versions.py +119 -0
  12. lucidshark-0.5.15/src/lucidshark/cli/__init__.py +50 -0
  13. lucidshark-0.5.15/src/lucidshark/cli/__main__.py +8 -0
  14. lucidshark-0.5.15/src/lucidshark/cli/arguments.py +405 -0
  15. lucidshark-0.5.15/src/lucidshark/cli/commands/__init__.py +64 -0
  16. lucidshark-0.5.15/src/lucidshark/cli/commands/autoconfigure.py +294 -0
  17. lucidshark-0.5.15/src/lucidshark/cli/commands/help.py +69 -0
  18. lucidshark-0.5.15/src/lucidshark/cli/commands/init.py +656 -0
  19. lucidshark-0.5.15/src/lucidshark/cli/commands/list_scanners.py +59 -0
  20. lucidshark-0.5.15/src/lucidshark/cli/commands/scan.py +316 -0
  21. lucidshark-0.5.15/src/lucidshark/cli/commands/serve.py +142 -0
  22. lucidshark-0.5.15/src/lucidshark/cli/commands/status.py +98 -0
  23. lucidshark-0.5.15/src/lucidshark/cli/commands/validate.py +89 -0
  24. lucidshark-0.5.15/src/lucidshark/cli/config_bridge.py +148 -0
  25. lucidshark-0.5.15/src/lucidshark/cli/exit_codes.py +17 -0
  26. lucidshark-0.5.15/src/lucidshark/cli/runner.py +284 -0
  27. lucidshark-0.5.15/src/lucidshark/config/__init__.py +29 -0
  28. lucidshark-0.5.15/src/lucidshark/config/ignore.py +209 -0
  29. lucidshark-0.5.15/src/lucidshark/config/loader.py +431 -0
  30. lucidshark-0.5.15/src/lucidshark/config/models.py +316 -0
  31. lucidshark-0.5.15/src/lucidshark/config/validation.py +729 -0
  32. lucidshark-0.5.15/src/lucidshark/core/__init__.py +3 -0
  33. lucidshark-0.5.15/src/lucidshark/core/domain_runner.py +467 -0
  34. lucidshark-0.5.15/src/lucidshark/core/git.py +174 -0
  35. lucidshark-0.5.15/src/lucidshark/core/logging.py +34 -0
  36. lucidshark-0.5.15/src/lucidshark/core/models.py +304 -0
  37. lucidshark-0.5.15/src/lucidshark/core/paths.py +75 -0
  38. lucidshark-0.5.15/src/lucidshark/core/streaming.py +340 -0
  39. lucidshark-0.5.15/src/lucidshark/core/subprocess_runner.py +164 -0
  40. lucidshark-0.5.15/src/lucidshark/detection/__init__.py +21 -0
  41. lucidshark-0.5.15/src/lucidshark/detection/detector.py +154 -0
  42. lucidshark-0.5.15/src/lucidshark/detection/frameworks.py +270 -0
  43. lucidshark-0.5.15/src/lucidshark/detection/languages.py +328 -0
  44. lucidshark-0.5.15/src/lucidshark/detection/tools.py +225 -0
  45. lucidshark-0.5.15/src/lucidshark/generation/__init__.py +15 -0
  46. lucidshark-0.5.15/src/lucidshark/generation/config_generator.py +275 -0
  47. lucidshark-0.5.15/src/lucidshark/generation/package_installer.py +330 -0
  48. lucidshark-0.5.15/src/lucidshark/mcp/__init__.py +20 -0
  49. lucidshark-0.5.15/src/lucidshark/mcp/formatter.py +510 -0
  50. lucidshark-0.5.15/src/lucidshark/mcp/server.py +297 -0
  51. lucidshark-0.5.15/src/lucidshark/mcp/tools.py +930 -0
  52. lucidshark-0.5.15/src/lucidshark/mcp/watcher.py +237 -0
  53. lucidshark-0.5.15/src/lucidshark/pipeline/__init__.py +17 -0
  54. lucidshark-0.5.15/src/lucidshark/pipeline/executor.py +187 -0
  55. lucidshark-0.5.15/src/lucidshark/pipeline/parallel.py +181 -0
  56. lucidshark-0.5.15/src/lucidshark/plugins/__init__.py +40 -0
  57. lucidshark-0.5.15/src/lucidshark/plugins/coverage/__init__.py +28 -0
  58. lucidshark-0.5.15/src/lucidshark/plugins/coverage/base.py +209 -0
  59. lucidshark-0.5.15/src/lucidshark/plugins/coverage/coverage_py.py +454 -0
  60. lucidshark-0.5.15/src/lucidshark/plugins/coverage/istanbul.py +411 -0
  61. lucidshark-0.5.15/src/lucidshark/plugins/discovery.py +126 -0
  62. lucidshark-0.5.15/src/lucidshark/plugins/enrichers/__init__.py +61 -0
  63. lucidshark-0.5.15/src/lucidshark/plugins/enrichers/base.py +63 -0
  64. lucidshark-0.5.15/src/lucidshark/plugins/linters/__init__.py +26 -0
  65. lucidshark-0.5.15/src/lucidshark/plugins/linters/base.py +125 -0
  66. lucidshark-0.5.15/src/lucidshark/plugins/linters/biome.py +450 -0
  67. lucidshark-0.5.15/src/lucidshark/plugins/linters/checkstyle.py +394 -0
  68. lucidshark-0.5.15/src/lucidshark/plugins/linters/eslint.py +415 -0
  69. lucidshark-0.5.15/src/lucidshark/plugins/linters/ruff.py +553 -0
  70. lucidshark-0.5.15/src/lucidshark/plugins/reporters/__init__.py +45 -0
  71. lucidshark-0.5.15/src/lucidshark/plugins/reporters/base.py +30 -0
  72. lucidshark-0.5.15/src/lucidshark/plugins/reporters/json_reporter.py +79 -0
  73. lucidshark-0.5.15/src/lucidshark/plugins/reporters/sarif_reporter.py +303 -0
  74. lucidshark-0.5.15/src/lucidshark/plugins/reporters/summary_reporter.py +61 -0
  75. lucidshark-0.5.15/src/lucidshark/plugins/reporters/table_reporter.py +81 -0
  76. lucidshark-0.5.15/src/lucidshark/plugins/scanners/__init__.py +57 -0
  77. lucidshark-0.5.15/src/lucidshark/plugins/scanners/base.py +60 -0
  78. lucidshark-0.5.15/src/lucidshark/plugins/scanners/checkov.py +489 -0
  79. lucidshark-0.5.15/src/lucidshark/plugins/scanners/opengrep.py +465 -0
  80. lucidshark-0.5.15/src/lucidshark/plugins/scanners/trivy.py +493 -0
  81. lucidshark-0.5.15/src/lucidshark/plugins/test_runners/__init__.py +27 -0
  82. lucidshark-0.5.15/src/lucidshark/plugins/test_runners/base.py +114 -0
  83. lucidshark-0.5.15/src/lucidshark/plugins/test_runners/jest.py +389 -0
  84. lucidshark-0.5.15/src/lucidshark/plugins/test_runners/karma.py +484 -0
  85. lucidshark-0.5.15/src/lucidshark/plugins/test_runners/playwright.py +438 -0
  86. lucidshark-0.5.15/src/lucidshark/plugins/test_runners/pytest.py +655 -0
  87. lucidshark-0.5.15/src/lucidshark/plugins/type_checkers/__init__.py +27 -0
  88. lucidshark-0.5.15/src/lucidshark/plugins/type_checkers/base.py +106 -0
  89. lucidshark-0.5.15/src/lucidshark/plugins/type_checkers/mypy.py +367 -0
  90. lucidshark-0.5.15/src/lucidshark/plugins/type_checkers/pyright.py +314 -0
  91. lucidshark-0.5.15/src/lucidshark/plugins/type_checkers/typescript.py +280 -0
  92. lucidshark-0.5.15/src/lucidshark.egg-info/PKG-INFO +247 -0
  93. lucidshark-0.5.15/src/lucidshark.egg-info/SOURCES.txt +95 -0
  94. lucidshark-0.5.15/src/lucidshark.egg-info/dependency_links.txt +1 -0
  95. lucidshark-0.5.15/src/lucidshark.egg-info/entry_points.txt +34 -0
  96. lucidshark-0.5.15/src/lucidshark.egg-info/requires.txt +17 -0
  97. lucidshark-0.5.15/src/lucidshark.egg-info/top_level.txt +1 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 Voldeq GmbH, Zollikofen, Switzerland
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,247 @@
1
+ Metadata-Version: 2.4
2
+ Name: lucidshark
3
+ Version: 0.5.15
4
+ Summary: LucidShark - The trust layer for AI-assisted development
5
+ Author-email: Voldeq GmbH <toni.antunovic@voldeq.com>
6
+ License: Apache-2.0
7
+ Keywords: security,scanner,devsecops,sast,sca,iac,container,vulnerability,trivy,semgrep,checkov,cli,mcp,ai,claude,cursor,linting,type-checking,testing,coverage
8
+ Classifier: Development Status :: 4 - Beta
9
+ Classifier: Environment :: Console
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Intended Audience :: Information Technology
12
+ Classifier: Intended Audience :: System Administrators
13
+ Classifier: License :: OSI Approved :: Apache Software License
14
+ Classifier: Operating System :: MacOS
15
+ Classifier: Operating System :: POSIX :: Linux
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Topic :: Security
21
+ Classifier: Topic :: Software Development :: Quality Assurance
22
+ Classifier: Topic :: Software Development :: Testing
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.10
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Requires-Dist: PyYAML>=6.0
28
+ Requires-Dist: pathspec>=0.12.0
29
+ Requires-Dist: questionary>=2.0
30
+ Requires-Dist: Jinja2>=3.0
31
+ Requires-Dist: mcp>=1.0.0
32
+ Requires-Dist: watchdog>=4.0.0
33
+ Requires-Dist: defusedxml>=0.7.1
34
+ Requires-Dist: tomli>=2.0.0; python_version < "3.11"
35
+ Provides-Extra: dev
36
+ Requires-Dist: pytest>=7.0; extra == "dev"
37
+ Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
38
+ Requires-Dist: mypy>=1.0; extra == "dev"
39
+ Requires-Dist: pyright>=1.1; extra == "dev"
40
+ Requires-Dist: types-PyYAML>=6.0; extra == "dev"
41
+ Dynamic: license-file
42
+
43
+ # LucidShark
44
+
45
+ <p align="center">
46
+ <img src="docs/lucidshark.png" alt="LucidShark" width="400">
47
+ </p>
48
+
49
+ [![CI](https://github.com/lucidshark-code/lucidshark/actions/workflows/ci.yml/badge.svg)](https://github.com/lucidshark-code/lucidshark/actions/workflows/ci.yml)
50
+ [![codecov](https://codecov.io/gh/lucidshark-code/lucidshark/graph/badge.svg)](https://codecov.io/gh/lucidshark-code/lucidshark)
51
+ [![PyPI version](https://img.shields.io/pypi/v/lucidshark)](https://pypi.org/project/lucidshark/)
52
+ [![Python](https://img.shields.io/pypi/pyversions/lucidshark)](https://pypi.org/project/lucidshark/)
53
+ [![License](https://img.shields.io/github/license/lucidshark-code/lucidshark)](https://github.com/lucidshark-code/lucidshark/blob/main/LICENSE)
54
+
55
+ **The trust layer for AI-assisted development.**
56
+
57
+ LucidShark unifies linting, type checking, security scanning, testing, and coverage into a single pipeline that auto-configures for any project and integrates with AI coding tools like Claude Code and Cursor.
58
+
59
+ ```
60
+ AI writes code → LucidShark checks → AI fixes → repeat
61
+ ```
62
+
63
+ ## Quick Start
64
+
65
+ ```bash
66
+ # 1. Install LucidShark
67
+ pip install lucidshark
68
+
69
+ # 2. Set up your AI tools (Claude Code and/or Cursor)
70
+ lucidshark init --all
71
+
72
+ # 3. Restart your AI tool, then ask it:
73
+ # "Autoconfigure LucidShark for this project"
74
+ ```
75
+
76
+ That's it! Your AI assistant will analyze your codebase, ask you a few questions, and generate the `lucidshark.yml` configuration.
77
+
78
+ ### Alternative: CLI Configuration
79
+
80
+ If you prefer to configure without AI:
81
+
82
+ ```bash
83
+ lucidshark autoconfigure
84
+ ```
85
+
86
+ ### Running Scans
87
+
88
+ ```bash
89
+ # Run the full quality pipeline
90
+ lucidshark scan --all
91
+
92
+ # Run specific checks
93
+ lucidshark scan --linting # Linting (Ruff, ESLint, Biome)
94
+ lucidshark scan --type-checking # Type checking (mypy, pyright, tsc)
95
+ lucidshark scan --sast # Security code analysis (OpenGrep)
96
+ lucidshark scan --sca # Dependency vulnerabilities (Trivy)
97
+ lucidshark scan --iac # Infrastructure-as-Code (Checkov)
98
+ lucidshark scan --container # Container image scanning (Trivy)
99
+ lucidshark scan --testing # Run tests (pytest, Jest)
100
+ lucidshark scan --coverage # Coverage analysis
101
+
102
+ # Auto-fix linting issues
103
+ lucidshark scan --linting --fix
104
+ ```
105
+
106
+ ### AI Tool Setup
107
+
108
+ #### Claude Code
109
+
110
+ ```bash
111
+ lucidshark init --claude-code
112
+ ```
113
+
114
+ This:
115
+ - Adds LucidShark to your Claude Code MCP configuration (`.mcp.json`)
116
+ - Creates `.claude/CLAUDE.md` with scan workflow instructions
117
+
118
+ Restart Claude Code to activate.
119
+
120
+ #### Cursor
121
+
122
+ ```bash
123
+ lucidshark init --cursor
124
+ ```
125
+
126
+ This:
127
+ - Adds LucidShark to Cursor's MCP configuration (`~/.cursor/mcp.json`)
128
+ - Creates `.cursor/rules/lucidshark.mdc` with auto-scan rules
129
+
130
+ #### All AI Tools
131
+
132
+ ```bash
133
+ lucidshark init --all
134
+ ```
135
+
136
+ Configures both Claude Code and Cursor.
137
+
138
+ ## What It Checks
139
+
140
+ | Domain | Tools | What It Catches |
141
+ |--------|-------|-----------------|
142
+ | **Linting** | Ruff, ESLint, Biome, Checkstyle | Style issues, code smells |
143
+ | **Type Checking** | mypy, pyright, TypeScript | Type errors |
144
+ | **Security (SAST)** | OpenGrep | Code vulnerabilities |
145
+ | **Security (SCA)** | Trivy | Dependency vulnerabilities |
146
+ | **Security (IaC)** | Checkov | Infrastructure misconfigurations |
147
+ | **Security (Container)** | Trivy | Container image vulnerabilities |
148
+ | **Testing** | pytest, Jest, Karma (Angular), Playwright (E2E) | Test failures |
149
+ | **Coverage** | coverage.py, Istanbul | Coverage gaps |
150
+
151
+ All results are normalized to a common format.
152
+
153
+ ## Configuration
154
+
155
+ LucidShark auto-detects your project. For custom settings, create `lucidshark.yml`:
156
+
157
+ ```yaml
158
+ version: 1
159
+
160
+ pipeline:
161
+ linting:
162
+ enabled: true
163
+ tools:
164
+ - name: ruff
165
+
166
+ type_checking:
167
+ enabled: true
168
+ tools:
169
+ - name: mypy
170
+ strict: true
171
+
172
+ security:
173
+ enabled: true
174
+ tools:
175
+ - name: trivy
176
+ - name: opengrep
177
+
178
+ testing:
179
+ enabled: true
180
+ tools:
181
+ - name: pytest
182
+
183
+ coverage:
184
+ enabled: true
185
+ threshold: 80
186
+
187
+ fail_on:
188
+ linting: error
189
+ security: high
190
+ testing: any
191
+
192
+ ignore:
193
+ - "**/node_modules/**"
194
+ - "**/.venv/**"
195
+ ```
196
+
197
+ ## CLI Reference
198
+
199
+ ```bash
200
+ # Configure AI tools (Claude Code, Cursor)
201
+ lucidshark init --claude-code # Configure Claude Code
202
+ lucidshark init --cursor # Configure Cursor
203
+ lucidshark init --all # Configure all AI tools
204
+
205
+ # Auto-configure project (detect languages, generate lucidshark.yml)
206
+ lucidshark autoconfigure [--ci github|gitlab|bitbucket] [--non-interactive]
207
+
208
+ # Run quality pipeline
209
+ lucidshark scan [--linting] [--type-checking] [--sca] [--sast] [--iac] [--container] [--testing] [--coverage] [--all]
210
+ lucidshark scan [--fix] [--stream] [--format table|json|sarif|summary]
211
+ lucidshark scan [--fail-on critical|high|medium|low]
212
+
213
+ # Server mode
214
+ lucidshark serve --mcp # Run MCP server
215
+ lucidshark serve --watch # Watch mode with auto-checking
216
+
217
+ # Show status
218
+ lucidshark status [--tools]
219
+ ```
220
+
221
+ ## Exit Codes
222
+
223
+ | Code | Meaning |
224
+ |------|---------|
225
+ | 0 | All checks passed |
226
+ | 1 | Issues found above threshold |
227
+ | 2 | Tool execution error |
228
+ | 3 | Configuration error |
229
+
230
+ ## Development
231
+
232
+ ```bash
233
+ git clone https://github.com/lucidshark-code/lucidshark.git
234
+ cd lucidshark
235
+ pip install -e ".[dev]"
236
+ pytest tests/
237
+ ```
238
+
239
+ ## Documentation
240
+
241
+ - [LLM Reference Documentation](docs/help.md) - For AI agents and detailed reference
242
+ - [Full Specification](docs/main.md)
243
+ - [Roadmap](docs/roadmap.md)
244
+
245
+ ## License
246
+
247
+ Apache 2.0
@@ -0,0 +1,205 @@
1
+ # LucidShark
2
+
3
+ <p align="center">
4
+ <img src="docs/lucidshark.png" alt="LucidShark" width="400">
5
+ </p>
6
+
7
+ [![CI](https://github.com/lucidshark-code/lucidshark/actions/workflows/ci.yml/badge.svg)](https://github.com/lucidshark-code/lucidshark/actions/workflows/ci.yml)
8
+ [![codecov](https://codecov.io/gh/lucidshark-code/lucidshark/graph/badge.svg)](https://codecov.io/gh/lucidshark-code/lucidshark)
9
+ [![PyPI version](https://img.shields.io/pypi/v/lucidshark)](https://pypi.org/project/lucidshark/)
10
+ [![Python](https://img.shields.io/pypi/pyversions/lucidshark)](https://pypi.org/project/lucidshark/)
11
+ [![License](https://img.shields.io/github/license/lucidshark-code/lucidshark)](https://github.com/lucidshark-code/lucidshark/blob/main/LICENSE)
12
+
13
+ **The trust layer for AI-assisted development.**
14
+
15
+ LucidShark unifies linting, type checking, security scanning, testing, and coverage into a single pipeline that auto-configures for any project and integrates with AI coding tools like Claude Code and Cursor.
16
+
17
+ ```
18
+ AI writes code → LucidShark checks → AI fixes → repeat
19
+ ```
20
+
21
+ ## Quick Start
22
+
23
+ ```bash
24
+ # 1. Install LucidShark
25
+ pip install lucidshark
26
+
27
+ # 2. Set up your AI tools (Claude Code and/or Cursor)
28
+ lucidshark init --all
29
+
30
+ # 3. Restart your AI tool, then ask it:
31
+ # "Autoconfigure LucidShark for this project"
32
+ ```
33
+
34
+ That's it! Your AI assistant will analyze your codebase, ask you a few questions, and generate the `lucidshark.yml` configuration.
35
+
36
+ ### Alternative: CLI Configuration
37
+
38
+ If you prefer to configure without AI:
39
+
40
+ ```bash
41
+ lucidshark autoconfigure
42
+ ```
43
+
44
+ ### Running Scans
45
+
46
+ ```bash
47
+ # Run the full quality pipeline
48
+ lucidshark scan --all
49
+
50
+ # Run specific checks
51
+ lucidshark scan --linting # Linting (Ruff, ESLint, Biome)
52
+ lucidshark scan --type-checking # Type checking (mypy, pyright, tsc)
53
+ lucidshark scan --sast # Security code analysis (OpenGrep)
54
+ lucidshark scan --sca # Dependency vulnerabilities (Trivy)
55
+ lucidshark scan --iac # Infrastructure-as-Code (Checkov)
56
+ lucidshark scan --container # Container image scanning (Trivy)
57
+ lucidshark scan --testing # Run tests (pytest, Jest)
58
+ lucidshark scan --coverage # Coverage analysis
59
+
60
+ # Auto-fix linting issues
61
+ lucidshark scan --linting --fix
62
+ ```
63
+
64
+ ### AI Tool Setup
65
+
66
+ #### Claude Code
67
+
68
+ ```bash
69
+ lucidshark init --claude-code
70
+ ```
71
+
72
+ This:
73
+ - Adds LucidShark to your Claude Code MCP configuration (`.mcp.json`)
74
+ - Creates `.claude/CLAUDE.md` with scan workflow instructions
75
+
76
+ Restart Claude Code to activate.
77
+
78
+ #### Cursor
79
+
80
+ ```bash
81
+ lucidshark init --cursor
82
+ ```
83
+
84
+ This:
85
+ - Adds LucidShark to Cursor's MCP configuration (`~/.cursor/mcp.json`)
86
+ - Creates `.cursor/rules/lucidshark.mdc` with auto-scan rules
87
+
88
+ #### All AI Tools
89
+
90
+ ```bash
91
+ lucidshark init --all
92
+ ```
93
+
94
+ Configures both Claude Code and Cursor.
95
+
96
+ ## What It Checks
97
+
98
+ | Domain | Tools | What It Catches |
99
+ |--------|-------|-----------------|
100
+ | **Linting** | Ruff, ESLint, Biome, Checkstyle | Style issues, code smells |
101
+ | **Type Checking** | mypy, pyright, TypeScript | Type errors |
102
+ | **Security (SAST)** | OpenGrep | Code vulnerabilities |
103
+ | **Security (SCA)** | Trivy | Dependency vulnerabilities |
104
+ | **Security (IaC)** | Checkov | Infrastructure misconfigurations |
105
+ | **Security (Container)** | Trivy | Container image vulnerabilities |
106
+ | **Testing** | pytest, Jest, Karma (Angular), Playwright (E2E) | Test failures |
107
+ | **Coverage** | coverage.py, Istanbul | Coverage gaps |
108
+
109
+ All results are normalized to a common format.
110
+
111
+ ## Configuration
112
+
113
+ LucidShark auto-detects your project. For custom settings, create `lucidshark.yml`:
114
+
115
+ ```yaml
116
+ version: 1
117
+
118
+ pipeline:
119
+ linting:
120
+ enabled: true
121
+ tools:
122
+ - name: ruff
123
+
124
+ type_checking:
125
+ enabled: true
126
+ tools:
127
+ - name: mypy
128
+ strict: true
129
+
130
+ security:
131
+ enabled: true
132
+ tools:
133
+ - name: trivy
134
+ - name: opengrep
135
+
136
+ testing:
137
+ enabled: true
138
+ tools:
139
+ - name: pytest
140
+
141
+ coverage:
142
+ enabled: true
143
+ threshold: 80
144
+
145
+ fail_on:
146
+ linting: error
147
+ security: high
148
+ testing: any
149
+
150
+ ignore:
151
+ - "**/node_modules/**"
152
+ - "**/.venv/**"
153
+ ```
154
+
155
+ ## CLI Reference
156
+
157
+ ```bash
158
+ # Configure AI tools (Claude Code, Cursor)
159
+ lucidshark init --claude-code # Configure Claude Code
160
+ lucidshark init --cursor # Configure Cursor
161
+ lucidshark init --all # Configure all AI tools
162
+
163
+ # Auto-configure project (detect languages, generate lucidshark.yml)
164
+ lucidshark autoconfigure [--ci github|gitlab|bitbucket] [--non-interactive]
165
+
166
+ # Run quality pipeline
167
+ lucidshark scan [--linting] [--type-checking] [--sca] [--sast] [--iac] [--container] [--testing] [--coverage] [--all]
168
+ lucidshark scan [--fix] [--stream] [--format table|json|sarif|summary]
169
+ lucidshark scan [--fail-on critical|high|medium|low]
170
+
171
+ # Server mode
172
+ lucidshark serve --mcp # Run MCP server
173
+ lucidshark serve --watch # Watch mode with auto-checking
174
+
175
+ # Show status
176
+ lucidshark status [--tools]
177
+ ```
178
+
179
+ ## Exit Codes
180
+
181
+ | Code | Meaning |
182
+ |------|---------|
183
+ | 0 | All checks passed |
184
+ | 1 | Issues found above threshold |
185
+ | 2 | Tool execution error |
186
+ | 3 | Configuration error |
187
+
188
+ ## Development
189
+
190
+ ```bash
191
+ git clone https://github.com/lucidshark-code/lucidshark.git
192
+ cd lucidshark
193
+ pip install -e ".[dev]"
194
+ pytest tests/
195
+ ```
196
+
197
+ ## Documentation
198
+
199
+ - [LLM Reference Documentation](docs/help.md) - For AI agents and detailed reference
200
+ - [Full Specification](docs/main.md)
201
+ - [Roadmap](docs/roadmap.md)
202
+
203
+ ## License
204
+
205
+ Apache 2.0