scriptit-cli 0.2.2__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.
Files changed (36) hide show
  1. scriptit_cli-0.2.2/.claude-plugin/marketplace.json +14 -0
  2. scriptit_cli-0.2.2/.github/workflows/ci.yml +23 -0
  3. scriptit_cli-0.2.2/.github/workflows/release.yml +64 -0
  4. scriptit_cli-0.2.2/.gitignore +13 -0
  5. scriptit_cli-0.2.2/CONTRIBUTING.md +103 -0
  6. scriptit_cli-0.2.2/LICENSE +202 -0
  7. scriptit_cli-0.2.2/PKG-INFO +599 -0
  8. scriptit_cli-0.2.2/README.md +366 -0
  9. scriptit_cli-0.2.2/SECURITY.md +48 -0
  10. scriptit_cli-0.2.2/agent-skills/.claude-plugin/icon.png +0 -0
  11. scriptit_cli-0.2.2/agent-skills/.claude-plugin/plugin.json +18 -0
  12. scriptit_cli-0.2.2/agent-skills/README.md +66 -0
  13. scriptit_cli-0.2.2/agent-skills/scriptit/SKILL.md +148 -0
  14. scriptit_cli-0.2.2/assets/logo.png +0 -0
  15. scriptit_cli-0.2.2/assets/squiggle.png +0 -0
  16. scriptit_cli-0.2.2/extra-skills/scriptit-browser-cookies/SKILL.md +209 -0
  17. scriptit_cli-0.2.2/pyproject.toml +79 -0
  18. scriptit_cli-0.2.2/scriptit_cli/__init__.py +17 -0
  19. scriptit_cli-0.2.2/scriptit_cli/analytics.py +244 -0
  20. scriptit_cli-0.2.2/scriptit_cli/auth.py +553 -0
  21. scriptit_cli-0.2.2/scriptit_cli/client.py +42 -0
  22. scriptit_cli-0.2.2/scriptit_cli/commands.py +302 -0
  23. scriptit_cli-0.2.2/scriptit_cli/config.py +19 -0
  24. scriptit_cli-0.2.2/scriptit_cli/errors.py +21 -0
  25. scriptit_cli-0.2.2/scriptit_cli/main.py +184 -0
  26. scriptit_cli-0.2.2/scriptit_cli/output.py +79 -0
  27. scriptit_cli-0.2.2/scriptit_cli/remote.py +1306 -0
  28. scriptit_cli-0.2.2/scriptit_cli/remote_auth.py +464 -0
  29. scriptit_cli-0.2.2/scriptit_cli/update_check.py +104 -0
  30. scriptit_cli-0.2.2/scriptit_cli/util.py +84 -0
  31. scriptit_cli-0.2.2/tests/conftest.py +52 -0
  32. scriptit_cli-0.2.2/tests/test_analytics.py +233 -0
  33. scriptit_cli-0.2.2/tests/test_approval_login.py +329 -0
  34. scriptit_cli-0.2.2/tests/test_keycloak_client_choice.py +42 -0
  35. scriptit_cli-0.2.2/tests/test_plugin_manifest.py +41 -0
  36. scriptit_cli-0.2.2/tests/test_remote_cli.py +2239 -0
@@ -0,0 +1,14 @@
1
+ {
2
+ "name": "script-it",
3
+ "description": "Script.it for Claude Code. Better automation in a world of agents.",
4
+ "owner": {
5
+ "name": "Script.it"
6
+ },
7
+ "plugins": [
8
+ {
9
+ "name": "scriptit",
10
+ "source": "./agent-skills",
11
+ "description": "Automations your teammates and your AI agents can both run, built from readable steps a human can verify."
12
+ }
13
+ ]
14
+ }
@@ -0,0 +1,23 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ test:
10
+ runs-on: ubuntu-latest
11
+ strategy:
12
+ fail-fast: false
13
+ matrix:
14
+ python-version: ["3.9", "3.11", "3.13"]
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+ - uses: actions/setup-python@v5
18
+ with:
19
+ python-version: ${{ matrix.python-version }}
20
+ - run: pip install -e ".[dev]"
21
+ - run: ruff check scriptit_cli tests
22
+ - run: ruff format --check scriptit_cli tests
23
+ - run: pytest -q
@@ -0,0 +1,64 @@
1
+ name: release
2
+
3
+ # Publishes a wheel to PyPI when a version tag is pushed.
4
+ #
5
+ # No secrets: PyPI trusted publishing verifies this workflow's identity, and
6
+ # the client carries no keys of its own — usage analytics ride the user's own
7
+ # authenticated connection to their deployment.
8
+
9
+ on:
10
+ push:
11
+ tags: ["v*"]
12
+ workflow_dispatch:
13
+ inputs:
14
+ dry_run:
15
+ description: "Build and check the wheel without publishing"
16
+ type: boolean
17
+ default: true
18
+
19
+ jobs:
20
+ build:
21
+ runs-on: ubuntu-latest
22
+ steps:
23
+ - uses: actions/checkout@v4
24
+
25
+ - uses: actions/setup-python@v5
26
+ with:
27
+ python-version: "3.11"
28
+
29
+ - name: Verify the tag matches the packaged version
30
+ if: startsWith(github.ref, 'refs/tags/v')
31
+ run: |
32
+ tag="${GITHUB_REF_NAME#v}"
33
+ packaged=$(python -c "import scriptit_cli; print(scriptit_cli.__version__)")
34
+ if [ "$tag" != "$packaged" ]; then
35
+ echo "tag $tag != scriptit_cli.__version__ $packaged" >&2
36
+ exit 1
37
+ fi
38
+
39
+ - name: Build
40
+ run: |
41
+ python -m pip install --upgrade build twine
42
+ python -m build
43
+ python -m twine check dist/*
44
+
45
+ - uses: actions/upload-artifact@v4
46
+ with:
47
+ name: dist
48
+ path: dist/
49
+
50
+ publish:
51
+ needs: build
52
+ if: startsWith(github.ref, 'refs/tags/v')
53
+ runs-on: ubuntu-latest
54
+ environment: pypi
55
+ permissions:
56
+ # Trusted publishing: PyPI verifies this workflow's identity, so no API
57
+ # token is stored anywhere.
58
+ id-token: write
59
+ steps:
60
+ - uses: actions/download-artifact@v4
61
+ with:
62
+ name: dist
63
+ path: dist/
64
+ - uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,13 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ .venv/
4
+ venv/
5
+ build/
6
+ dist/
7
+ *.egg-info/
8
+ .pytest_cache/
9
+ .mypy_cache/
10
+ .ruff_cache/
11
+ .DS_Store
12
+ .coverage
13
+ htmlcov/
@@ -0,0 +1,103 @@
1
+ # Contributing
2
+
3
+ Thanks for helping. Issues and pull requests are both welcome.
4
+
5
+ ## Setup
6
+
7
+ ```bash
8
+ git clone https://github.com/script-it/cli.git
9
+ cd cli
10
+ python -m venv .venv && source .venv/bin/activate
11
+ pip install -e ".[dev]"
12
+ pytest
13
+ ```
14
+
15
+ The suite is fast and needs no network or account — it covers the pure pieces
16
+ (v2 output paging and reconnects, v1 command wrapping and exit-sentinel
17
+ parsing, SSE framing, the credential store, session resolution). Anything that needs a live environment is exercised by
18
+ hand against a real account before release.
19
+
20
+ `tests/conftest.py` points `XDG_CONFIG_HOME` at a temp directory for every
21
+ test. Keep it that way: without it the credential-store tests read and
22
+ overwrite the real `~/.config/scriptit/credentials.json` on your machine.
23
+
24
+ ## The boundary
25
+
26
+ The client forwards commands and formats what comes back; it does not execute
27
+ automation, parse scripts, or know what a block is. Its dependencies are
28
+ `requests`, `fire`, `filelock` and `packaging` — all small, and each earning
29
+ its place: the last two replace hand-rolled code that was wrong on Windows and
30
+ wrong about PEP 440.
31
+
32
+ That boundary is what lets the platform ship features without a client release,
33
+ and it is easy to erode by accident. If a change needs the runtime, it belongs
34
+ in the platform, not here.
35
+
36
+ `remote.py` supports two deployed session transports. The initial SSE frame
37
+ selects one before dispatch: v2 uses `session_snapshot`, v1 uses
38
+ `load_complete`. V2 sends plain commands, reads output by byte cursor and
39
+ gets exit status from shell events or a saved shell row. V1 requires base64
40
+ wrapping, an exit sentinel and file recovery after its SSE text cap; keep that
41
+ compatibility code isolated.
42
+
43
+ A shell POST is not safe to repeat after a lost response. Retry only a refusal
44
+ that explicitly says it was not submitted. V2 event reconnects send
45
+ `Last-Event-ID`, match this invocation's message/shell identity and resume
46
+ output reads from the returned byte cursor. A saved truncated preview must
47
+ never count as complete command output.
48
+
49
+ In practice that means:
50
+
51
+ - Adding a command that Script.it should answer? Add it there instead — it
52
+ reaches users through the client they already have.
53
+ - Adding one this client must answer (credentials, transport, moving bytes,
54
+ session bookkeeping)? Add it to `CLIENT_COMMANDS` in `scriptit_cli/remote.py`,
55
+ to `_KNOWN_TOKENS` in `scriptit_cli/analytics.py`, and give it `--json`
56
+ output — or list it in `JSON_STREAMING_COMMANDS` if it streams raw bytes
57
+ instead of returning a result.
58
+ - Never name a client command something the platform also uses. The client
59
+ answers its own names first, so a collision silently shadows the real one.
60
+
61
+ ## Analytics
62
+
63
+ `scriptit_cli/analytics.py` reports command *names*, never their contents. The
64
+ filter is an allowlist (`_KNOWN_TOKENS`), not a pattern — a script name, a
65
+ workspace path and a bearer token are all shaped like a verb, so only "is this
66
+ one of ours?" can tell them apart. A new client command belongs in that set as
67
+ well as in `CLIENT_COMMANDS`; a test asserts the two agree, and another drives
68
+ a real invocation with secrets in argv and asserts they reach no payload.
69
+
70
+ There is no collector and no key here. Events go to the user's own deployment,
71
+ on the credential the command already used, so `Analytics` is inert until
72
+ something calls `bind()`. That is also why your tests collect nothing by
73
+ default, and why `DO_NOT_TRACK=1` is the whole opt-out.
74
+
75
+ ## Platform support
76
+
77
+ Linux and macOS are what we test; the client is written to work on Windows
78
+ too. The store lock goes through `filelock`, which uses each platform's own
79
+ primitive, so concurrent credential and state writes serialize everywhere
80
+ rather than only on POSIX. Windows is not in CI, so if something there is
81
+ broken, an issue with a reproduction would be welcome.
82
+
83
+ ## Pull requests
84
+
85
+ - Include a test for behavior you change. Write the assertion around *why* it
86
+ matters, not just what the function returns — the transport has several
87
+ properties (no duplicated execution after a lost acknowledgement, complete
88
+ Unicode output across pages, `--json` keeping stdout clean) that are invisible
89
+ until they break.
90
+ - Keep comments about what the code does now, not what it used to do. Change
91
+ history belongs in commits.
92
+ - Run `pytest`, `ruff check` and `ruff format` before pushing. CI runs all
93
+ three on Python 3.9, 3.11 and 3.13.
94
+
95
+ ## Reporting a bug
96
+
97
+ Include the client version (`scriptit version`), your Python version, the
98
+ command you ran, and what happened. If it involves a command that ran in your
99
+ environment, `scriptit session current` tells you which session to look at in
100
+ the app — that transcript is usually the fastest way to see what went wrong.
101
+
102
+ Please don't paste credentials, tokens, or the contents of
103
+ `~/.config/scriptit/credentials.json` into an issue.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.