copper-pilot-cli 0.1.1__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.
- copper_pilot_cli-0.1.1/.gitignore +9 -0
- copper_pilot_cli-0.1.1/CODE_OF_CONDUCT.md +131 -0
- copper_pilot_cli-0.1.1/CONTRIBUTING.md +99 -0
- copper_pilot_cli-0.1.1/HISTORY.md +19 -0
- copper_pilot_cli-0.1.1/LICENSE +22 -0
- copper_pilot_cli-0.1.1/NOTICE +13 -0
- copper_pilot_cli-0.1.1/PKG-INFO +211 -0
- copper_pilot_cli-0.1.1/README.md +147 -0
- copper_pilot_cli-0.1.1/SECURITY.md +32 -0
- copper_pilot_cli-0.1.1/SUPPORT.md +8 -0
- copper_pilot_cli-0.1.1/UPSTREAM.md +44 -0
- copper_pilot_cli-0.1.1/VERSION +1 -0
- copper_pilot_cli-0.1.1/docs/assets/esp32-mini-1-h4.gif +0 -0
- copper_pilot_cli-0.1.1/docs/assets/logo-dark.png +0 -0
- copper_pilot_cli-0.1.1/docs/assets/logo-light.png +0 -0
- copper_pilot_cli-0.1.1/docs/assets/logo.png +0 -0
- copper_pilot_cli-0.1.1/docs/cli.md +110 -0
- copper_pilot_cli-0.1.1/docs/development.md +61 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/.copperpilot/PLANS.md +5 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/.copperpilot/README.md +16 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/.copperpilot/TOOLS.md +5 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/.copperpilot/plans/esp32-dev-board.plan.md +168 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/.gitignore +9 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/README.md +29 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/esp32/3d-models/SW-SMD_L3.9-W2.9-H2.0-LS4.8.step +25818 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/esp32/3d-models/TYPE-C-31-M-12.step +20916 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/esp32/esp32.kicad_pcb +11357 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/esp32/esp32.kicad_pro +655 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/esp32/esp32.kicad_sch +9309 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/esp32/esp32.png +0 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/helper.py +520 -0
- copper_pilot_cli-0.1.1/examples/001_esp32/main.py +38 -0
- copper_pilot_cli-0.1.1/pyproject.toml +114 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/__init__.py +37 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/__main__.py +6 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/_upstream/__init__.py +0 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/_upstream/dcode_0_1_69/PROVENANCE.json +46 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/_upstream/dcode_0_1_69/__init__.py +0 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/_upstream/dcode_0_1_69/diff_utils.py +222 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/_version.py +32 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/clipboard.py +107 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_api.py +24 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_app.py +1071 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_auth.py +232 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_config.py +62 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_features.py +263 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_graph.py +178 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_hooks.py +49 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_main.py +345 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_preferences.py +85 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_presentation.py +325 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_protocol.py +421 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_theme.py +34 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_tools.py +23 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_update.py +32 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_widgets.py +1224 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/copper_workspace.py +151 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/deepagents_tools.py +556 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/diagnostics.py +55 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/langchain.py +215 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/media_utils.py +626 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/py.typed +0 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/sessions.py +1578 -0
- copper_pilot_cli-0.1.1/src/copper_pilot_cli/textual_patches.py +35 -0
- copper_pilot_cli-0.1.1/tests/test_auth.py +77 -0
- copper_pilot_cli-0.1.1/tests/test_clipboard.py +96 -0
- copper_pilot_cli-0.1.1/tests/test_e2e.py +214 -0
- copper_pilot_cli-0.1.1/tests/test_esp32_example.py +156 -0
- copper_pilot_cli-0.1.1/tests/test_features.py +92 -0
- copper_pilot_cli-0.1.1/tests/test_langchain.py +55 -0
- copper_pilot_cli-0.1.1/tests/test_live_chat_e2e.py +166 -0
- copper_pilot_cli-0.1.1/tests/test_main.py +101 -0
- copper_pilot_cli-0.1.1/tests/test_preferences.py +36 -0
- copper_pilot_cli-0.1.1/tests/test_presentation.py +30 -0
- copper_pilot_cli-0.1.1/tests/test_protocol.py +281 -0
- copper_pilot_cli-0.1.1/tests/test_release_gates.py +161 -0
- copper_pilot_cli-0.1.1/tests/test_sessions.py +97 -0
- copper_pilot_cli-0.1.1/tests/test_tools.py +225 -0
- copper_pilot_cli-0.1.1/tests/test_tui.py +995 -0
- copper_pilot_cli-0.1.1/tests/test_upstream_provenance.py +33 -0
- copper_pilot_cli-0.1.1/tests/test_workspace.py +32 -0
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
- Demonstrating empathy and kindness toward other people
|
|
21
|
+
- Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
- Giving and gracefully accepting constructive feedback
|
|
23
|
+
- Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
- Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
- The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
- Public or private harassment
|
|
34
|
+
- Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
- Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail
|
|
56
|
+
address, posting via an official social media account, or acting as an
|
|
57
|
+
appointed representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly
|
|
63
|
+
and fairly.
|
|
64
|
+
|
|
65
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
66
|
+
reporter of any incident.
|
|
67
|
+
|
|
68
|
+
## Enforcement Guidelines
|
|
69
|
+
|
|
70
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
71
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
72
|
+
|
|
73
|
+
### 1. Correction
|
|
74
|
+
|
|
75
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
76
|
+
unprofessional or unwelcome in the community.
|
|
77
|
+
|
|
78
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
79
|
+
clarity around the nature of the violation and an explanation of why the
|
|
80
|
+
behavior was inappropriate. A public apology may be requested.
|
|
81
|
+
|
|
82
|
+
### 2. Warning
|
|
83
|
+
|
|
84
|
+
**Community Impact**: A violation through a single incident or series of
|
|
85
|
+
actions.
|
|
86
|
+
|
|
87
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
88
|
+
interaction with the people involved, including unsolicited interaction with
|
|
89
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
90
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
91
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
92
|
+
ban.
|
|
93
|
+
|
|
94
|
+
### 3. Temporary Ban
|
|
95
|
+
|
|
96
|
+
**Community Impact**: A serious violation of community standards, including
|
|
97
|
+
sustained inappropriate behavior.
|
|
98
|
+
|
|
99
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
100
|
+
communication with the community for a specified period of time. No public or
|
|
101
|
+
private interaction with the people involved, including unsolicited interaction
|
|
102
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
103
|
+
Violating these terms may lead to a permanent ban.
|
|
104
|
+
|
|
105
|
+
### 4. Permanent Ban
|
|
106
|
+
|
|
107
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
108
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
109
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
110
|
+
|
|
111
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
112
|
+
community.
|
|
113
|
+
|
|
114
|
+
## Attribution
|
|
115
|
+
|
|
116
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
117
|
+
version 2.1, available at
|
|
118
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
119
|
+
|
|
120
|
+
Community Impact Guidelines were inspired by
|
|
121
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
122
|
+
|
|
123
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
124
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
125
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
126
|
+
|
|
127
|
+
[homepage]: https://www.contributor-covenant.org
|
|
128
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
129
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
130
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
131
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thanks for helping improve CopperPilot CLI. By participating you agree to the
|
|
4
|
+
[Code of Conduct](CODE_OF_CONDUCT.md).
|
|
5
|
+
|
|
6
|
+
This repository is the open-source terminal and LangChain client for the hosted
|
|
7
|
+
CopperPilot agent. It is not the desktop app or the hosted backend.
|
|
8
|
+
|
|
9
|
+
## Prerequisites
|
|
10
|
+
|
|
11
|
+
- Python 3.12 or newer
|
|
12
|
+
- [pip](https://pip.pypa.io/en/stable/)
|
|
13
|
+
- [make](https://www.gnu.org/software/make/) (optional; the same commands are
|
|
14
|
+
listed below)
|
|
15
|
+
- A CopperPilot account only if you run live tests
|
|
16
|
+
- KiCad 10 on `PATH` only for [`examples/001_esp32`](examples/001_esp32)
|
|
17
|
+
|
|
18
|
+
## Set up a development install
|
|
19
|
+
|
|
20
|
+
```console
|
|
21
|
+
git clone https://github.com/CopperPilot/copper-pilot-cli.git
|
|
22
|
+
cd copper-pilot-cli
|
|
23
|
+
python3 -m venv .venv
|
|
24
|
+
source .venv/bin/activate # Windows: .venv\Scripts\activate
|
|
25
|
+
pip install -e ".[dev]"
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
On Windows, Git Bash or PowerShell both work; `make` is optional.
|
|
29
|
+
|
|
30
|
+
## Format, lint, and test
|
|
31
|
+
|
|
32
|
+
```console
|
|
33
|
+
make fmt
|
|
34
|
+
make lint
|
|
35
|
+
make test
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Without `make`:
|
|
39
|
+
|
|
40
|
+
```console
|
|
41
|
+
python -m ruff format src tests examples
|
|
42
|
+
python -m ruff format --check src tests examples
|
|
43
|
+
python -m ruff check src tests examples
|
|
44
|
+
python -m ty check src/copper_pilot_cli
|
|
45
|
+
python -m pytest -m "not live"
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
`make test` skips tests marked `live`. Live tests exercise device login, the
|
|
49
|
+
Textual composer, the hosted stream, and local-tool round trips. They use the
|
|
50
|
+
normal private credential store and skip when no credential is present:
|
|
51
|
+
|
|
52
|
+
```console
|
|
53
|
+
copper-pilot auth login
|
|
54
|
+
pytest -m live
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Never commit `~/.copper-pilot/.state/auth.json`, API keys, or private boards.
|
|
58
|
+
|
|
59
|
+
## Pull requests
|
|
60
|
+
|
|
61
|
+
1. Create a branch from `main`.
|
|
62
|
+
2. Keep the change focused: one bug, feature, or docs fix per PR.
|
|
63
|
+
3. Add or update tests. Coverage of new branches in `src/copper_pilot_cli`
|
|
64
|
+
(except `_upstream/`) is expected.
|
|
65
|
+
4. Update docs when behavior changes: [README.md](README.md),
|
|
66
|
+
[docs/cli.md](docs/cli.md), or [docs/development.md](docs/development.md).
|
|
67
|
+
5. Run `make fmt && make lint && make test`.
|
|
68
|
+
6. Open a pull request with the template. Fill in the test plan.
|
|
69
|
+
|
|
70
|
+
CI runs lint, tests, `pip-audit`, a license check, and a wheel install on
|
|
71
|
+
every pull request.
|
|
72
|
+
|
|
73
|
+
## Scope of this package
|
|
74
|
+
|
|
75
|
+
Keep this client a hosted-agent frontend. Do not add:
|
|
76
|
+
|
|
77
|
+
- Hosted-server or `copper_pilot_core` code
|
|
78
|
+
- Model or provider pickers
|
|
79
|
+
- Local model execution
|
|
80
|
+
- Computer use
|
|
81
|
+
- MCP or plugin controls
|
|
82
|
+
- LangSmith tracing or content telemetry
|
|
83
|
+
- Sandbox runtimes
|
|
84
|
+
|
|
85
|
+
Upstream Textual presentation is vendored under
|
|
86
|
+
`src/copper_pilot_cli/_upstream/` with provenance in [UPSTREAM.md](UPSTREAM.md)
|
|
87
|
+
and [NOTICE](NOTICE). When porting upstream changes, follow that document;
|
|
88
|
+
do not reintroduce upstream runtime surfaces.
|
|
89
|
+
|
|
90
|
+
## Reporting issues
|
|
91
|
+
|
|
92
|
+
Use the [bug report form](https://github.com/CopperPilot/copper-pilot-cli/issues/new?template=bug_report.yml)
|
|
93
|
+
and include steps to reproduce. Security issues go to [SECURITY.md](SECURITY.md),
|
|
94
|
+
not the public tracker.
|
|
95
|
+
|
|
96
|
+
## Release
|
|
97
|
+
|
|
98
|
+
Maintainers cut a release with `make release`. See
|
|
99
|
+
[docs/development.md](docs/development.md#release).
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
Changelog
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
0.1.0 (2026-09-17)
|
|
6
|
+
------------------
|
|
7
|
+
- Release: version 0.1.0 🚀 [AdityaNG]
|
|
8
|
+
- Fix(tests/test_release_gates.py) [AdityaNG]
|
|
9
|
+
- Test. [AdityaNG]
|
|
10
|
+
- Docs. [AdityaNG]
|
|
11
|
+
- Docs. [AdityaNG]
|
|
12
|
+
- Example(examples/001_esp32/) [AdityaNG]
|
|
13
|
+
- Makefile. [AdityaNG]
|
|
14
|
+
- Ci. [AdityaNG]
|
|
15
|
+
- Docs. [AdityaNG]
|
|
16
|
+
- Refactor(name) [AdityaNG]
|
|
17
|
+
- Init. [AdityaNG]
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 CopperPilot, Inc.
|
|
4
|
+
Copyright (c) LangChain, Inc.
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
CopperPilot CLI includes modified portions of Deep Agents Code.
|
|
2
|
+
|
|
3
|
+
Deep Agents Code
|
|
4
|
+
Copyright (c) LangChain, Inc.
|
|
5
|
+
Licensed under the MIT License.
|
|
6
|
+
|
|
7
|
+
Upstream source:
|
|
8
|
+
https://github.com/langchain-ai/deepagents
|
|
9
|
+
|
|
10
|
+
Pinned source revision:
|
|
11
|
+
1d3232c0852c47af09119edea10eeec887e4f0da
|
|
12
|
+
|
|
13
|
+
The LangChain name and trademarks are not used to endorse CopperPilot.
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: copper-pilot-cli
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: CopperPilot hosted agent for the terminal and LangChain
|
|
5
|
+
Project-URL: Homepage, https://copperpilot.ai
|
|
6
|
+
Project-URL: Repository, https://github.com/CopperPilot/copper-pilot-cli
|
|
7
|
+
Project-URL: Issues, https://github.com/CopperPilot/copper-pilot-cli/issues
|
|
8
|
+
Project-URL: Documentation, https://github.com/CopperPilot/copper-pilot-cli#readme
|
|
9
|
+
Project-URL: Changelog, https://github.com/CopperPilot/copper-pilot-cli/releases
|
|
10
|
+
Author: CopperPilot
|
|
11
|
+
License: MIT License
|
|
12
|
+
|
|
13
|
+
Copyright (c) 2026 CopperPilot, Inc.
|
|
14
|
+
Copyright (c) LangChain, Inc.
|
|
15
|
+
|
|
16
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
17
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
18
|
+
in the Software without restriction, including without limitation the rights
|
|
19
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
20
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
21
|
+
furnished to do so, subject to the following conditions:
|
|
22
|
+
|
|
23
|
+
The above copyright notice and this permission notice shall be included in all
|
|
24
|
+
copies or substantial portions of the Software.
|
|
25
|
+
|
|
26
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
27
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
28
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
29
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
30
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
31
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
32
|
+
SOFTWARE.
|
|
33
|
+
License-File: LICENSE
|
|
34
|
+
License-File: NOTICE
|
|
35
|
+
Requires-Python: <4,>=3.12
|
|
36
|
+
Requires-Dist: aiosqlite<1,>=0.22
|
|
37
|
+
Requires-Dist: certifi>=2024.8.30
|
|
38
|
+
Requires-Dist: deepagents==0.7.14
|
|
39
|
+
Requires-Dist: httpx<1,>=0.28
|
|
40
|
+
Requires-Dist: langchain-core<2,>=1.6
|
|
41
|
+
Requires-Dist: langgraph-checkpoint-sqlite<4,>=3.1
|
|
42
|
+
Requires-Dist: langgraph<2,>=1.2
|
|
43
|
+
Requires-Dist: markdownify<2,>=1.2
|
|
44
|
+
Requires-Dist: packaging<27,>=25
|
|
45
|
+
Requires-Dist: pillow<13,>=12
|
|
46
|
+
Requires-Dist: pydantic<3,>=2.12
|
|
47
|
+
Requires-Dist: pyperclip<2,>=1.11
|
|
48
|
+
Requires-Dist: pyyaml<7,>=6
|
|
49
|
+
Requires-Dist: rich<16,>=15
|
|
50
|
+
Requires-Dist: textual<9,>=8.2.8
|
|
51
|
+
Requires-Dist: uuid-utils<1,>=0.12
|
|
52
|
+
Requires-Dist: websockets<17,>=15
|
|
53
|
+
Provides-Extra: dev
|
|
54
|
+
Requires-Dist: build<2,>=1.4; extra == 'dev'
|
|
55
|
+
Requires-Dist: gitchangelog==3.0.4; extra == 'dev'
|
|
56
|
+
Requires-Dist: pip-audit<3,>=2.10; extra == 'dev'
|
|
57
|
+
Requires-Dist: pip-licenses<6,>=5; extra == 'dev'
|
|
58
|
+
Requires-Dist: pytest-asyncio<2,>=1.3; extra == 'dev'
|
|
59
|
+
Requires-Dist: pytest-cov<8,>=7; extra == 'dev'
|
|
60
|
+
Requires-Dist: pytest<10,>=9; extra == 'dev'
|
|
61
|
+
Requires-Dist: ruff<1,>=0.14; extra == 'dev'
|
|
62
|
+
Requires-Dist: ty>=0.0.1; extra == 'dev'
|
|
63
|
+
Description-Content-Type: text/markdown
|
|
64
|
+
|
|
65
|
+
<div align="center">
|
|
66
|
+
<a href="https://copperpilot.ai">
|
|
67
|
+
<picture>
|
|
68
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/CopperPilot/copper-pilot-cli/blob/main/docs/assets/logo-dark.png?raw=true">
|
|
69
|
+
<source media="(prefers-color-scheme: light)" srcset="https://github.com/CopperPilot/copper-pilot-cli/blob/main/docs/assets/logo-light.png?raw=true">
|
|
70
|
+
<img alt="CopperPilot" src="https://github.com/CopperPilot/copper-pilot-cli/blob/main/docs/assets/logo-light.png?raw=true" width="55%">
|
|
71
|
+
</picture>
|
|
72
|
+
</a>
|
|
73
|
+
</div>
|
|
74
|
+
|
|
75
|
+
<div align="center">
|
|
76
|
+
<h3>The AI for PCB design, in your terminal.</h3>
|
|
77
|
+
</div>
|
|
78
|
+
|
|
79
|
+
<div align="center">
|
|
80
|
+
<a href="https://github.com/CopperPilot/copper-pilot-cli/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/copper-pilot-cli" alt="License"></a>
|
|
81
|
+
<a href="https://pypi.org/project/copper-pilot-cli/"><img src="https://img.shields.io/pypi/v/copper-pilot-cli" alt="PyPI version"></a>
|
|
82
|
+
<a href="https://pypi.org/project/copper-pilot-cli/"><img src="https://img.shields.io/pypi/pyversions/copper-pilot-cli" alt="Python"></a>
|
|
83
|
+
<a href="https://github.com/CopperPilot/copper-pilot-cli/actions/workflows/ci.yml"><img src="https://github.com/CopperPilot/copper-pilot-cli/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
|
|
84
|
+
</div>
|
|
85
|
+
|
|
86
|
+
<div align="center">
|
|
87
|
+
<a href="https://x.com/copperpilot_ai"><img src="https://img.shields.io/twitter/follow/copperpilot_ai?style=social" alt="Follow on X"></a>
|
|
88
|
+
<a href="https://www.linkedin.com/company/copperpilot"><img src="https://img.shields.io/badge/LinkedIn-CopperPilot-0A66C2?logo=linkedin&logoColor=white" alt="LinkedIn"></a>
|
|
89
|
+
<a href="https://www.youtube.com/@CopperPilot"><img src="https://img.shields.io/badge/YouTube-@CopperPilot-FF0000?logo=youtube&logoColor=white" alt="YouTube"></a>
|
|
90
|
+
<a href="https://www.instagram.com/copperpilot.ai/"><img src="https://img.shields.io/badge/Instagram-copperpilot.ai-E4405F?logo=instagram&logoColor=white" alt="Instagram"></a>
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
<br>
|
|
94
|
+
|
|
95
|
+
CopperPilot in your terminal: a thin, open-source client for CopperPilot electronics design agent, the best AI for PCB Design.
|
|
96
|
+
|
|
97
|
+
<p align="center">
|
|
98
|
+
<img src="https://github.com/CopperPilot/copper-pilot-cli/blob/main/docs/assets/esp32-mini-1-h4.gif?raw=true" alt="CopperPilot building an ESP32-MINI-1 board">
|
|
99
|
+
</p>
|
|
100
|
+
|
|
101
|
+
## Prerequisites
|
|
102
|
+
|
|
103
|
+
- Python 3.12 or newer
|
|
104
|
+
- A [CopperPilot](https://copperpilot.ai) account for login
|
|
105
|
+
- KiCad 10 on `PATH` only if you run [`examples/001_esp32`](examples/001_esp32)
|
|
106
|
+
|
|
107
|
+
## Install and run
|
|
108
|
+
|
|
109
|
+
```console
|
|
110
|
+
pip install copper-pilot-cli
|
|
111
|
+
copper-pilot
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
The first interactive launch opens a browser for CopperPilot device login.
|
|
115
|
+
With no path argument, the current directory is the workspace and a new chat
|
|
116
|
+
starts immediately. Any existing directory is valid.
|
|
117
|
+
|
|
118
|
+
```console
|
|
119
|
+
copper-pilot ./my-board
|
|
120
|
+
copper-pilot --resume
|
|
121
|
+
copper-pilot threads list
|
|
122
|
+
copper-pilot -n -m "Review this board" --json
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Both `copper-pilot` and `copper-pilot-cli` run the same program.
|
|
126
|
+
`copper-pilot --help` lists flags; [docs/cli.md](docs/cli.md) is the full
|
|
127
|
+
command reference.
|
|
128
|
+
|
|
129
|
+
## Configuration
|
|
130
|
+
|
|
131
|
+
- Production API: `https://copperpilot.ai`
|
|
132
|
+
- Development override: `COPPER_PILOT_API_URL`
|
|
133
|
+
- User state: `~/.copper-pilot/.state`
|
|
134
|
+
- Project artifacts: `.copperpilot/`
|
|
135
|
+
|
|
136
|
+
Credentials are stored in a private, atomically replaced `auth.json`; on POSIX
|
|
137
|
+
the parent directory is mode `0700` and the file is mode `0600`.
|
|
138
|
+
|
|
139
|
+
## LangChain
|
|
140
|
+
|
|
141
|
+
```python
|
|
142
|
+
from copper_pilot_cli.copper_protocol import CopperMode
|
|
143
|
+
from copper_pilot_cli.langchain import CopperPilotAgent
|
|
144
|
+
from helper import drc_violations, erc_errors, render_pcb, run
|
|
145
|
+
|
|
146
|
+
PLAN = CopperMode.PLAN
|
|
147
|
+
|
|
148
|
+
copper_pilot = CopperPilotAgent(workspace="esp32")
|
|
149
|
+
|
|
150
|
+
run(copper_pilot, "Build me an ESP32 dev board.", PLAN)
|
|
151
|
+
run(copper_pilot, "Let us build this plan.")
|
|
152
|
+
run(copper_pilot, "Inspect the PCB, check for any missing 3D models, and apply them accordingly.")
|
|
153
|
+
|
|
154
|
+
assert erc_errors() == 0
|
|
155
|
+
assert drc_violations() == 0
|
|
156
|
+
render_pcb("esp32.png")
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
`CopperPilotAgent` is a `Runnable`, not a chat model. It represents a complete
|
|
160
|
+
hosted agent run, including local tool requests. Use `as_langgraph()` for graph
|
|
161
|
+
composition or `as_compiled_subagent()` for explicit delegation from an outer
|
|
162
|
+
Deep Agent. The compatible `deepagents` runtime is installed and pinned by this
|
|
163
|
+
package.
|
|
164
|
+
|
|
165
|
+
That snippet is the runnable example in
|
|
166
|
+
[`examples/001_esp32`](examples/001_esp32).
|
|
167
|
+
|
|
168
|
+
## Security boundary
|
|
169
|
+
|
|
170
|
+
The hosted agent may request local filesystem and shell tools. Reads and
|
|
171
|
+
searches run freely. Writes, edits, deletes, and shell commands are gated by
|
|
172
|
+
Manual approval by default. Auto permits only deterministic routine actions;
|
|
173
|
+
unknown actions still ask. YOLO must be selected explicitly.
|
|
174
|
+
|
|
175
|
+
Filesystem, search, edit, and shell execution use Deep Agents' native
|
|
176
|
+
`FilesystemMiddleware` tools and `LocalShellBackend`; CopperPilot's adapter only
|
|
177
|
+
normalizes hosted tool names, approval decisions, and result envelopes.
|
|
178
|
+
|
|
179
|
+
Computer use, model/provider selection, local model execution, LangSmith
|
|
180
|
+
tracing, content telemetry, MCP/plugin controls, and server implementation code
|
|
181
|
+
are not part of this package.
|
|
182
|
+
|
|
183
|
+
See [UPSTREAM.md](UPSTREAM.md) and [NOTICE](NOTICE) for the retained Textual
|
|
184
|
+
client attribution.
|
|
185
|
+
|
|
186
|
+
To report a vulnerability, see [SECURITY.md](SECURITY.md).
|
|
187
|
+
|
|
188
|
+
## Development
|
|
189
|
+
|
|
190
|
+
```console
|
|
191
|
+
pip install -e ".[dev]"
|
|
192
|
+
make fmt
|
|
193
|
+
make lint
|
|
194
|
+
make test
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
`make test` runs `pytest -m "not live"`. Live tests skip unless a CopperPilot
|
|
198
|
+
credential is stored. Release tagging is `make release`. Details:
|
|
199
|
+
[docs/development.md](docs/development.md).
|
|
200
|
+
|
|
201
|
+
## Contributing
|
|
202
|
+
|
|
203
|
+
Bug reports, features, and pull requests are welcome. Please read
|
|
204
|
+
[CONTRIBUTING.md](CONTRIBUTING.md) and the
|
|
205
|
+
[Code of Conduct](CODE_OF_CONDUCT.md). Use the
|
|
206
|
+
[bug report form](https://github.com/CopperPilot/copper-pilot-cli/issues/new?template=bug_report.yml)
|
|
207
|
+
so we can reproduce the problem.
|
|
208
|
+
|
|
209
|
+
## License
|
|
210
|
+
|
|
211
|
+
[MIT](LICENSE).
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<a href="https://copperpilot.ai">
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/CopperPilot/copper-pilot-cli/blob/main/docs/assets/logo-dark.png?raw=true">
|
|
5
|
+
<source media="(prefers-color-scheme: light)" srcset="https://github.com/CopperPilot/copper-pilot-cli/blob/main/docs/assets/logo-light.png?raw=true">
|
|
6
|
+
<img alt="CopperPilot" src="https://github.com/CopperPilot/copper-pilot-cli/blob/main/docs/assets/logo-light.png?raw=true" width="55%">
|
|
7
|
+
</picture>
|
|
8
|
+
</a>
|
|
9
|
+
</div>
|
|
10
|
+
|
|
11
|
+
<div align="center">
|
|
12
|
+
<h3>The AI for PCB design, in your terminal.</h3>
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
<div align="center">
|
|
16
|
+
<a href="https://github.com/CopperPilot/copper-pilot-cli/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/copper-pilot-cli" alt="License"></a>
|
|
17
|
+
<a href="https://pypi.org/project/copper-pilot-cli/"><img src="https://img.shields.io/pypi/v/copper-pilot-cli" alt="PyPI version"></a>
|
|
18
|
+
<a href="https://pypi.org/project/copper-pilot-cli/"><img src="https://img.shields.io/pypi/pyversions/copper-pilot-cli" alt="Python"></a>
|
|
19
|
+
<a href="https://github.com/CopperPilot/copper-pilot-cli/actions/workflows/ci.yml"><img src="https://github.com/CopperPilot/copper-pilot-cli/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
<div align="center">
|
|
23
|
+
<a href="https://x.com/copperpilot_ai"><img src="https://img.shields.io/twitter/follow/copperpilot_ai?style=social" alt="Follow on X"></a>
|
|
24
|
+
<a href="https://www.linkedin.com/company/copperpilot"><img src="https://img.shields.io/badge/LinkedIn-CopperPilot-0A66C2?logo=linkedin&logoColor=white" alt="LinkedIn"></a>
|
|
25
|
+
<a href="https://www.youtube.com/@CopperPilot"><img src="https://img.shields.io/badge/YouTube-@CopperPilot-FF0000?logo=youtube&logoColor=white" alt="YouTube"></a>
|
|
26
|
+
<a href="https://www.instagram.com/copperpilot.ai/"><img src="https://img.shields.io/badge/Instagram-copperpilot.ai-E4405F?logo=instagram&logoColor=white" alt="Instagram"></a>
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
<br>
|
|
30
|
+
|
|
31
|
+
CopperPilot in your terminal: a thin, open-source client for CopperPilot electronics design agent, the best AI for PCB Design.
|
|
32
|
+
|
|
33
|
+
<p align="center">
|
|
34
|
+
<img src="https://github.com/CopperPilot/copper-pilot-cli/blob/main/docs/assets/esp32-mini-1-h4.gif?raw=true" alt="CopperPilot building an ESP32-MINI-1 board">
|
|
35
|
+
</p>
|
|
36
|
+
|
|
37
|
+
## Prerequisites
|
|
38
|
+
|
|
39
|
+
- Python 3.12 or newer
|
|
40
|
+
- A [CopperPilot](https://copperpilot.ai) account for login
|
|
41
|
+
- KiCad 10 on `PATH` only if you run [`examples/001_esp32`](examples/001_esp32)
|
|
42
|
+
|
|
43
|
+
## Install and run
|
|
44
|
+
|
|
45
|
+
```console
|
|
46
|
+
pip install copper-pilot-cli
|
|
47
|
+
copper-pilot
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The first interactive launch opens a browser for CopperPilot device login.
|
|
51
|
+
With no path argument, the current directory is the workspace and a new chat
|
|
52
|
+
starts immediately. Any existing directory is valid.
|
|
53
|
+
|
|
54
|
+
```console
|
|
55
|
+
copper-pilot ./my-board
|
|
56
|
+
copper-pilot --resume
|
|
57
|
+
copper-pilot threads list
|
|
58
|
+
copper-pilot -n -m "Review this board" --json
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Both `copper-pilot` and `copper-pilot-cli` run the same program.
|
|
62
|
+
`copper-pilot --help` lists flags; [docs/cli.md](docs/cli.md) is the full
|
|
63
|
+
command reference.
|
|
64
|
+
|
|
65
|
+
## Configuration
|
|
66
|
+
|
|
67
|
+
- Production API: `https://copperpilot.ai`
|
|
68
|
+
- Development override: `COPPER_PILOT_API_URL`
|
|
69
|
+
- User state: `~/.copper-pilot/.state`
|
|
70
|
+
- Project artifacts: `.copperpilot/`
|
|
71
|
+
|
|
72
|
+
Credentials are stored in a private, atomically replaced `auth.json`; on POSIX
|
|
73
|
+
the parent directory is mode `0700` and the file is mode `0600`.
|
|
74
|
+
|
|
75
|
+
## LangChain
|
|
76
|
+
|
|
77
|
+
```python
|
|
78
|
+
from copper_pilot_cli.copper_protocol import CopperMode
|
|
79
|
+
from copper_pilot_cli.langchain import CopperPilotAgent
|
|
80
|
+
from helper import drc_violations, erc_errors, render_pcb, run
|
|
81
|
+
|
|
82
|
+
PLAN = CopperMode.PLAN
|
|
83
|
+
|
|
84
|
+
copper_pilot = CopperPilotAgent(workspace="esp32")
|
|
85
|
+
|
|
86
|
+
run(copper_pilot, "Build me an ESP32 dev board.", PLAN)
|
|
87
|
+
run(copper_pilot, "Let us build this plan.")
|
|
88
|
+
run(copper_pilot, "Inspect the PCB, check for any missing 3D models, and apply them accordingly.")
|
|
89
|
+
|
|
90
|
+
assert erc_errors() == 0
|
|
91
|
+
assert drc_violations() == 0
|
|
92
|
+
render_pcb("esp32.png")
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
`CopperPilotAgent` is a `Runnable`, not a chat model. It represents a complete
|
|
96
|
+
hosted agent run, including local tool requests. Use `as_langgraph()` for graph
|
|
97
|
+
composition or `as_compiled_subagent()` for explicit delegation from an outer
|
|
98
|
+
Deep Agent. The compatible `deepagents` runtime is installed and pinned by this
|
|
99
|
+
package.
|
|
100
|
+
|
|
101
|
+
That snippet is the runnable example in
|
|
102
|
+
[`examples/001_esp32`](examples/001_esp32).
|
|
103
|
+
|
|
104
|
+
## Security boundary
|
|
105
|
+
|
|
106
|
+
The hosted agent may request local filesystem and shell tools. Reads and
|
|
107
|
+
searches run freely. Writes, edits, deletes, and shell commands are gated by
|
|
108
|
+
Manual approval by default. Auto permits only deterministic routine actions;
|
|
109
|
+
unknown actions still ask. YOLO must be selected explicitly.
|
|
110
|
+
|
|
111
|
+
Filesystem, search, edit, and shell execution use Deep Agents' native
|
|
112
|
+
`FilesystemMiddleware` tools and `LocalShellBackend`; CopperPilot's adapter only
|
|
113
|
+
normalizes hosted tool names, approval decisions, and result envelopes.
|
|
114
|
+
|
|
115
|
+
Computer use, model/provider selection, local model execution, LangSmith
|
|
116
|
+
tracing, content telemetry, MCP/plugin controls, and server implementation code
|
|
117
|
+
are not part of this package.
|
|
118
|
+
|
|
119
|
+
See [UPSTREAM.md](UPSTREAM.md) and [NOTICE](NOTICE) for the retained Textual
|
|
120
|
+
client attribution.
|
|
121
|
+
|
|
122
|
+
To report a vulnerability, see [SECURITY.md](SECURITY.md).
|
|
123
|
+
|
|
124
|
+
## Development
|
|
125
|
+
|
|
126
|
+
```console
|
|
127
|
+
pip install -e ".[dev]"
|
|
128
|
+
make fmt
|
|
129
|
+
make lint
|
|
130
|
+
make test
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
`make test` runs `pytest -m "not live"`. Live tests skip unless a CopperPilot
|
|
134
|
+
credential is stored. Release tagging is `make release`. Details:
|
|
135
|
+
[docs/development.md](docs/development.md).
|
|
136
|
+
|
|
137
|
+
## Contributing
|
|
138
|
+
|
|
139
|
+
Bug reports, features, and pull requests are welcome. Please read
|
|
140
|
+
[CONTRIBUTING.md](CONTRIBUTING.md) and the
|
|
141
|
+
[Code of Conduct](CODE_OF_CONDUCT.md). Use the
|
|
142
|
+
[bug report form](https://github.com/CopperPilot/copper-pilot-cli/issues/new?template=bug_report.yml)
|
|
143
|
+
so we can reproduce the problem.
|
|
144
|
+
|
|
145
|
+
## License
|
|
146
|
+
|
|
147
|
+
[MIT](LICENSE).
|