rscot-agent 1.2.0

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 (4) hide show
  1. package/LICENSE +161 -0
  2. package/README.md +81 -0
  3. package/dist/index.js +1741 -0
  4. package/package.json +54 -0
package/LICENSE ADDED
@@ -0,0 +1,161 @@
1
+ Rscot Source-Available NonCommercial License v1.0 (RSANC-1.0)
2
+ ================================================================
3
+
4
+ Copyright (c) 2026 wireless-intelligence (lead: Wen, contact: academic686@163.com)
5
+
6
+ This is a source-available, non-commercial license. You may obtain a
7
+ commercial license for additional rights by contacting academic686@163.com.
8
+
9
+ ----------------------------------------------------------------------
10
+ 1. Definitions
11
+ ----------------------------------------------------------------------
12
+ "Software" means the source code, object code, documentation, assets,
13
+ and any accompanying materials provided under this License (collectively
14
+ the "Work"), and any portion thereof.
15
+
16
+ "You" (or "Your") means any natural person or legal entity exercising
17
+ permissions granted by this License.
18
+
19
+ "Non-Commercial Use" means any use of the Software that is NOT primarily
20
+ intended for, or directed toward, commercial advantage or monetary
21
+ compensation. The following are explicit examples of Non-Commercial Use
22
+ permitted by this License:
23
+ (a) personal use by a natural person on their own devices;
24
+ (b) academic research and teaching;
25
+ (c) evaluation, testing, and benchmarking for up to ninety (90) days;
26
+ (d) use by registered non-profit organizations for their charitable
27
+ mission;
28
+ (e) contribution to the Work (issues, pull requests, forks for
29
+ personal improvement).
30
+
31
+ "Commercial Use" means any use of the Software that does NOT qualify
32
+ as Non-Commercial Use, including without limitation:
33
+ (a) any use by, on behalf of, or for the benefit of a for-profit
34
+ entity in connection with revenue-generating activities;
35
+ (b) inclusion of the Software, in whole or in part, in any product,
36
+ service, hosted offering, or distribution channel that is paid,
37
+ sponsored, ad-supported, or otherwise monetized;
38
+ (c) use of the Software to provide consulting, contracting, or
39
+ managed services to third parties;
40
+ (d) use after the ninety (90) day evaluation period referenced
41
+ above by any for-profit entity.
42
+
43
+ A separate Commercial License from the Licensor (academic686@163.com)
44
+ is required for any Commercial Use.
45
+
46
+ ----------------------------------------------------------------------
47
+ 2. Grant of Rights (Non-Commercial)
48
+ ----------------------------------------------------------------------
49
+ Subject to the terms and conditions of this License, the Licensor
50
+ hereby grants You a worldwide, royalty-free, non-exclusive,
51
+ non-transferable, revocable license to:
52
+
53
+ (a) use, reproduce, and run the Software for Non-Commercial Use;
54
+ (b) prepare derivative works of the Software solely for Non-Commercial
55
+ Use, provided that any derivative work is itself made available
56
+ under the terms of this License;
57
+ (c) distribute the Software (in source or object form) for
58
+ Non-Commercial Use, provided that:
59
+ (i) the complete, unmodified text of this License is included
60
+ with every copy;
61
+ (ii) all original copyright, attribution, and identification
62
+ notices are preserved;
63
+ (iii) recipients are made aware that the Software is licensed
64
+ under RSANC-1.0 and that Commercial Use requires a
65
+ separate license.
66
+
67
+ ----------------------------------------------------------------------
68
+ 3. Restrictions
69
+ ----------------------------------------------------------------------
70
+ You may NOT, without a separate Commercial License from the Licensor:
71
+
72
+ (a) use the Software for any Commercial Use;
73
+ (b) sublicense, sell, lease, rent, host as a paid or ad-supported
74
+ service, or otherwise monetize the Software or any derivative
75
+ work thereof;
76
+ (c) remove or alter any copyright, attribution, trademark, or
77
+ license notices contained in the Software;
78
+ (d) use the names "Rscot", "Rscot Agent", "Recot", or
79
+ "wireless-intelligence" to endorse, market, or promote products
80
+ or services derived from the Software, except to factually state
81
+ that your work is derived from the Software;
82
+ (e) circumvent any license-key, telemetry-opt-out, or usage-
83
+ reporting mechanism intended by the Licensor for the purpose of
84
+ distinguishing Commercial Use from Non-Commercial Use.
85
+
86
+ ----------------------------------------------------------------------
87
+ 4. Patent Grant
88
+ ----------------------------------------------------------------------
89
+ The Licensor grants You a worldwide, royalty-free, non-exclusive
90
+ patent license, limited to the patent claims owned or controlled by
91
+ the Licensor and necessarily infringed by Your Non-Commercial Use of
92
+ the Software as distributed by the Licensor. This patent license
93
+ terminates automatically and immediately upon any breach of this
94
+ License, and does NOT extend to Commercial Use.
95
+
96
+ ----------------------------------------------------------------------
97
+ 5. Contributions
98
+ ----------------------------------------------------------------------
99
+ By submitting a contribution (including but not limited to code,
100
+ documentation, configuration, or assets) to the Licensor, You agree
101
+ that the Licensor may relicense Your contribution under this License
102
+ and under any future Commercial License of the Licensor's choosing,
103
+ without further compensation to You. You represent that each such
104
+ contribution is Your original work or You have the right to submit it
105
+ under these terms.
106
+
107
+ ----------------------------------------------------------------------
108
+ 6. Trademarks
109
+ ----------------------------------------------------------------------
110
+ This License does NOT grant any rights in or to any trademark, service
111
+ mark, trade dress, or logo of the Licensor, including without
112
+ limitation "Rscot", "Rscot Agent", and "Recot". Trademark usage is
113
+ governed separately and requires prior written consent.
114
+
115
+ ----------------------------------------------------------------------
116
+ 7. No Warranty
117
+ ----------------------------------------------------------------------
118
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
119
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
120
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND
121
+ NON-INFRINGEMENT.
122
+
123
+ ----------------------------------------------------------------------
124
+ 8. Limitation of Liability
125
+ ----------------------------------------------------------------------
126
+ IN NO EVENT SHALL THE LICENSOR BE LIABLE FOR ANY CLAIM, DAMAGES, OR
127
+ OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE,
128
+ ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE
129
+ OR OTHER DEALINGS IN THE SOFTWARE.
130
+
131
+ ----------------------------------------------------------------------
132
+ 9. Termination
133
+ ----------------------------------------------------------------------
134
+ This License and the rights granted hereunder shall automatically
135
+ terminate upon any breach by You of the terms hereof. Upon
136
+ termination, You shall cease all use of the Software and destroy all
137
+ copies in Your possession or control. Sections 4 (Patent Grant — to
138
+ the extent it survives), 5 (Contributions), 6 (Trademarks), 7 (No
139
+ Warranty), 8 (Limitation of Liability), and 10 (Governing Law) shall
140
+ survive termination.
141
+
142
+ ----------------------------------------------------------------------
143
+ 10. Governing Law
144
+ ----------------------------------------------------------------------
145
+ This License shall be governed by and construed in accordance with the
146
+ laws of the People's Republic of China, without regard to its conflict
147
+ of law rules. Any dispute arising from or relating to this License
148
+ that cannot be resolved by good-faith negotiation shall be submitted
149
+ to the courts of competent jurisdiction located in the People's
150
+ Republic of China.
151
+
152
+ ----------------------------------------------------------------------
153
+ 11. Commercial License Inquiries
154
+ ----------------------------------------------------------------------
155
+ For a commercial license, OEM bundling, hosted-service use, or
156
+ custom-terms inquiries, contact:
157
+
158
+ academic686@163.com
159
+ wireless-intelligence (lead: Wen)
160
+
161
+ End of License.
package/README.md ADDED
@@ -0,0 +1,81 @@
1
+ # rscot-agent
2
+
3
+ > One-shot onboarding for **Rscot Agent** — local-first, source-available coding agent. Pick a provider, paste a key, you're done.
4
+
5
+ ![v1.2.0](https://img.shields.io/badge/version-1.2.0-orange) ![node ≥18](https://img.shields.io/badge/node-%E2%89%A518-339933) ![License RSANC-1.0](https://img.shields.io/badge/license-RSANC--1.0-7c5cff)
6
+
7
+ ---
8
+
9
+ ## What it does
10
+
11
+ ```sh
12
+ npx rscot
13
+ ```
14
+
15
+ In about 60 seconds:
16
+
17
+ 1. **Probes your environment** — node, python, git, ripgrep, ollama, existing provider keys in env
18
+ 2. **Picks an LLM provider** — DeepSeek (default), OpenAI, Anthropic, OpenRouter, Ollama (more in the desktop app + VSCode extension)
19
+ 3. **Pastes your key** — masked input, written to `~/.rscot/keys/<provider>.key` with `chmod 600`
20
+ 4. **Writes config** — `~/.rscot/config.json`, prints next commands
21
+
22
+ The agent **brain** (FastAPI backend, tool-use loop, knowledge layer) and **execution shell** (desktop app / VSCode extension) install separately — this package is just the front door.
23
+
24
+ ## Install
25
+
26
+ One-shot via `npx` (recommended):
27
+
28
+ ```sh
29
+ npx rscot
30
+ ```
31
+
32
+ Or install globally:
33
+
34
+ ```sh
35
+ npm i -g rscot-agent
36
+ rscot
37
+ ```
38
+
39
+ ## CLI
40
+
41
+ ```
42
+ rscot run the interactive onboarding flow
43
+ rscot --version print version
44
+ rscot --help print help
45
+ rscot --no-prompt env probe only (CI-safe smoke test)
46
+ ```
47
+
48
+ ## What gets written
49
+
50
+ | Path | Mode | What |
51
+ | ------------------------------- | -------- | ------------------------------------------ |
52
+ | `~/.rscot/config.json` | `0600` | Provider, model, env-var name, install ts |
53
+ | `~/.rscot/keys/<provider>.key` | `0600` | API key (only if you pasted one) |
54
+
55
+ Override the config root with `RSCOT_HOME=/some/path` before launch.
56
+
57
+ ## Uninstall
58
+
59
+ ```sh
60
+ rm -rf ~/.rscot
61
+ npm uninstall -g rscot-agent # if installed globally
62
+ ```
63
+
64
+ Removes config + every stored key.
65
+
66
+ ## Privacy & security
67
+
68
+ - Keys live **only on your disk** — `~/.rscot/keys/<provider>.key`, `chmod 600`, never transmitted by this package
69
+ - **No telemetry** — this CLI never phones home; runs fully offline after the npm install
70
+ - Pasted keys are **masked** during input; nothing is echoed or written to shell history
71
+
72
+ ## Companion installs
73
+
74
+ - **Desktop app** ([learningfind.com/install](https://learningfind.com/install)) — full multi-window flow + 11-provider catalog
75
+ - **VSCode extension** — `code --install-extension recot.rscot-agent` — sidebar inline with your editor
76
+
77
+ Sessions sync across desktop + VSCode via the local backend.
78
+
79
+ ## License
80
+
81
+ Source-available under [RSANC-1.0](LICENSE) — free for personal, academic, non-profit, and 90-day evaluation use. Commercial use requires a separate license from `academic686@163.com`.