ferrum-cli 0.1.0__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.
@@ -0,0 +1,211 @@
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.
67
+
68
+ Subject to the terms and conditions of this License, each Contributor
69
+ hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
70
+ royalty-free, irrevocable copyright license to reproduce, prepare
71
+ Derivative Works of, publicly display, publicly perform, sublicense,
72
+ and distribute the Work and such Derivative Works in Source or Object
73
+ form.
74
+
75
+ 3. Grant of Patent License.
76
+
77
+ Subject to the terms and conditions of this License, each Contributor
78
+ hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
79
+ royalty-free, irrevocable (except as stated in this section) patent
80
+ license to make, have made, use, offer to sell, sell, import, and
81
+ otherwise transfer the Work, where such license applies only to those
82
+ patent claims licensable by such Contributor that are necessarily
83
+ infringed by their Contribution(s) alone or by combination of their
84
+ Contribution(s) with the Work to which such Contribution(s) was
85
+ submitted. If You institute patent litigation against any entity
86
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
87
+ the Work or a Contribution incorporated within the Work constitutes
88
+ direct or contributory patent infringement, then any patent licenses
89
+ granted to You under this License for that Work shall terminate
90
+ as of the date such litigation is filed.
91
+
92
+ 4. Redistribution.
93
+
94
+ You may reproduce and distribute copies of the Work or Derivative
95
+ Works thereof in any medium, with or without modifications, and in
96
+ Source or Object form, provided that You meet the following conditions:
97
+
98
+ (a) You must give any other recipients of the Work or Derivative Works
99
+ a copy of this License; and
100
+
101
+ (b) You must cause any modified files to carry prominent notices
102
+ stating that You changed the files; and
103
+
104
+ (c) You must retain, in the Source form of any Derivative Works that
105
+ You distribute, all copyright, patent, trademark, and attribution
106
+ notices from the Source form of the Work, excluding those notices
107
+ that do not pertain to any part of the Derivative Works; and
108
+
109
+ (d) If the Work includes a "NOTICE" text file as part of its
110
+ distribution, then any Derivative Works that You distribute must
111
+ include a readable copy of the attribution notices contained
112
+ within such NOTICE file, excluding those notices that do not
113
+ pertain to any part of the Derivative Works, in at least one
114
+ of the following places: within a NOTICE text file distributed
115
+ as part of the Derivative Works; within the Source form or
116
+ documentation, if provided along with the Derivative Works; or,
117
+ within a display generated by the Derivative Works, if and
118
+ wherever such third-party notices normally appear. The contents
119
+ of the NOTICE file are for informational purposes only and
120
+ do not modify the License. You may add Your own attribution
121
+ notices within Derivative Works that You distribute, alongside
122
+ or as an addendum to the NOTICE text from the Work, provided
123
+ that such additional attribution notices cannot be construed
124
+ as modifying the License.
125
+
126
+ You may add Your own copyright statement to Your modifications and
127
+ may provide additional or different license terms and conditions
128
+ for use, reproduction, or distribution of Your modifications, or
129
+ for any such Derivative Works as a whole, provided Your use,
130
+ reproduction, and distribution of the Work otherwise complies with
131
+ the conditions stated in this License.
132
+
133
+ 5. Submission of Contributions.
134
+
135
+ Unless You explicitly state otherwise, any Contribution intentionally
136
+ submitted for inclusion in the Work by You to the Licensor shall be
137
+ under the terms and conditions of this License, without any additional
138
+ terms or conditions. Notwithstanding the above, nothing herein shall
139
+ supersede or modify the terms of any separate license agreement you
140
+ may have executed with Licensor regarding such Contributions.
141
+
142
+ 6. Trademarks.
143
+
144
+ This License does not grant permission to use the trade names,
145
+ trademarks, service marks, or product names of the Licensor, except as
146
+ required for reasonable and customary use in describing the origin of
147
+ the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty.
150
+
151
+ Unless required by applicable law or agreed to in writing, Licensor
152
+ provides the Work (and each Contributor provides its Contributions)
153
+ on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
154
+ either express or implied, including, without limitation, any
155
+ warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY,
156
+ or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
157
+ determining the appropriateness of using or redistributing the Work
158
+ and assume any risks associated with Your exercise of permissions
159
+ under this License.
160
+
161
+ 8. Limitation of Liability.
162
+
163
+ In no event and under no legal theory, whether in tort (including
164
+ negligence), contract, or otherwise, unless required by applicable law
165
+ (such as deliberate and grossly negligent acts) or agreed to in
166
+ writing, shall any Contributor be liable to You for damages, including
167
+ any direct, indirect, special, incidental, or consequential damages
168
+ of any character arising as a result of this License or out of the
169
+ use or inability to use the Work (including but not limited to damages
170
+ for loss of goodwill, work stoppage, computer failure or malfunction,
171
+ or any and all other commercial damages or losses), even if such
172
+ Contributor has been advised of the possibility of such damages.
173
+
174
+ 9. Accepting Warranty or Additional Liability.
175
+
176
+ While redistributing the Work or Derivative Works thereof, You may
177
+ choose to offer, and charge a fee for, acceptance of support,
178
+ warranty, indemnity, or other liability obligations and/or rights
179
+ consistent with this License. However, in accepting such obligations,
180
+ You may act only on Your own behalf and on Your sole responsibility,
181
+ not on behalf of any other Contributor, and only if You agree to
182
+ indemnify, defend, and hold each Contributor harmless for any
183
+ liability incurred by, or claims asserted against, such Contributor
184
+ by reason of your accepting any such warranty or additional liability.
185
+
186
+ END OF TERMS AND CONDITIONS
187
+
188
+ APPENDIX: How to apply the Apache License to your work.
189
+
190
+ To apply the Apache License to your work, attach the following
191
+ boilerplate notice, with the fields enclosed by brackets "[]"
192
+ replaced with your own identifying information. (Don't include
193
+ the brackets!) The text should be enclosed in the appropriate
194
+ comment syntax for the file format. We also recommend that a
195
+ file or class name and description of purpose be included on the
196
+ same "printed page" as the copyright notice for easier
197
+ identification within third-party archives.
198
+
199
+ Copyright 2026 Manit Mishra
200
+
201
+ Licensed under the Apache License, Version 2.0 (the "License");
202
+ you may not use this file except in compliance with the License.
203
+ You may obtain a copy of the License at
204
+
205
+ http://www.apache.org/licenses/LICENSE-2.0
206
+
207
+ Unless required by applicable law or agreed to in writing, software
208
+ distributed under the License is distributed on an "AS IS" BASIS,
209
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
210
+ See the License for the specific language governing permissions and
211
+ limitations under the License.
@@ -0,0 +1,74 @@
1
+ Metadata-Version: 2.4
2
+ Name: ferrum-cli
3
+ Version: 0.1.0
4
+ Summary: A lightweight coding harness for low-level and systems programming: inspect, understand, patch, verify.
5
+ Author: Ferrum contributors
6
+ License-Expression: Apache-2.0
7
+ Keywords: cli,systems-programming,c,cpp,rust,assembly
8
+ Classifier: Development Status :: 3 - Alpha
9
+ Classifier: Environment :: Console
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Topic :: Software Development :: Debuggers
13
+ Requires-Python: >=3.10
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Dynamic: license-file
17
+
18
+ # Ferrum
19
+
20
+ Ferrum is an open-source coding harness for low-level and systems work.
21
+
22
+ It is built for people working close to the machine: C, C++, Rust, Assembly, debugging, compilers, memory, and other systems-heavy code. Ferrum gives an AI model the context and tools it needs to work on a real codebase instead of guessing from a chat window.
23
+
24
+ ## Why Ferrum?
25
+
26
+ AI tools are great at app code, but systems programming is different. A useful systems coding agent has to understand the current code, compiler output, build behavior, and low-level details before making a change.
27
+
28
+ Ferrum is built around that idea.
29
+
30
+ ```text
31
+ Understand → Change → Build → Verify
32
+ ```
33
+
34
+ The goal is simple: make AI genuinely useful when the code lives near the machine.
35
+
36
+ ## What it gives you
37
+
38
+ - project and source-code context
39
+ - code search and inspection
40
+ - controlled file changes
41
+ - compiler and build feedback
42
+ - testing and verification
43
+ - tools designed for systems work
44
+
45
+ Ferrum also stays model-agnostic, so the underlying AI can change without changing the harness.
46
+
47
+ ## Current state
48
+
49
+ Ferrum is still early, but the core loop is the main focus right now.
50
+
51
+ The long-term direction includes things like:
52
+
53
+ - C/C++/Rust/Assembly tooling
54
+ - compiler and build-system integration
55
+ - debugger integration
56
+ - binary and executable analysis
57
+ - better project understanding
58
+ - extensible tools for systems developers
59
+
60
+ ## Contributing
61
+
62
+ Ferrum is meant to be built in public.
63
+
64
+ You do not need to be an AI expert to contribute. Code, tests, documentation, examples, bug reports, ideas, and improvements are all welcome.
65
+
66
+ See [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
67
+
68
+ Please read the [Code of Conduct](CODE_OF_CONDUCT.md) before participating.
69
+
70
+ ## License
71
+
72
+ Ferrum is licensed under the Apache License 2.0.
73
+
74
+ See [LICENSE](LICENSE) for the full license.
@@ -0,0 +1,57 @@
1
+ # Ferrum
2
+
3
+ Ferrum is an open-source coding harness for low-level and systems work.
4
+
5
+ It is built for people working close to the machine: C, C++, Rust, Assembly, debugging, compilers, memory, and other systems-heavy code. Ferrum gives an AI model the context and tools it needs to work on a real codebase instead of guessing from a chat window.
6
+
7
+ ## Why Ferrum?
8
+
9
+ AI tools are great at app code, but systems programming is different. A useful systems coding agent has to understand the current code, compiler output, build behavior, and low-level details before making a change.
10
+
11
+ Ferrum is built around that idea.
12
+
13
+ ```text
14
+ Understand → Change → Build → Verify
15
+ ```
16
+
17
+ The goal is simple: make AI genuinely useful when the code lives near the machine.
18
+
19
+ ## What it gives you
20
+
21
+ - project and source-code context
22
+ - code search and inspection
23
+ - controlled file changes
24
+ - compiler and build feedback
25
+ - testing and verification
26
+ - tools designed for systems work
27
+
28
+ Ferrum also stays model-agnostic, so the underlying AI can change without changing the harness.
29
+
30
+ ## Current state
31
+
32
+ Ferrum is still early, but the core loop is the main focus right now.
33
+
34
+ The long-term direction includes things like:
35
+
36
+ - C/C++/Rust/Assembly tooling
37
+ - compiler and build-system integration
38
+ - debugger integration
39
+ - binary and executable analysis
40
+ - better project understanding
41
+ - extensible tools for systems developers
42
+
43
+ ## Contributing
44
+
45
+ Ferrum is meant to be built in public.
46
+
47
+ You do not need to be an AI expert to contribute. Code, tests, documentation, examples, bug reports, ideas, and improvements are all welcome.
48
+
49
+ See [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
50
+
51
+ Please read the [Code of Conduct](CODE_OF_CONDUCT.md) before participating.
52
+
53
+ ## License
54
+
55
+ Ferrum is licensed under the Apache License 2.0.
56
+
57
+ See [LICENSE](LICENSE) for the full license.
@@ -0,0 +1,6 @@
1
+ """Ferrum — a coding harness for low-level and systems programming.
2
+
3
+ Understand -> Change -> Build -> Verify.
4
+ """
5
+
6
+ __version__ = "0.1.0"