@shadowclone/cli 0.0.30 → 0.0.31
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.
package/README.md
CHANGED
|
@@ -7,11 +7,13 @@
|
|
|
7
7
|
[](LICENSE)
|
|
8
8
|
[](https://hol.org/registry/plugins/theonly1me%2Fshadowclone)
|
|
9
9
|
|
|
10
|
-
[Quick start](#quick-start) · [What you get](#what-you-get) · [Skills](#skills-in-the-box) · [Cloud bot](
|
|
10
|
+
[Quick start](#quick-start) · [What you get](#what-you-get) · [Skills](#skills-in-the-box) · [Reviews](#reviews-on-your-machine-and-on-github) · [Cloud bot](#a-cloud-bot-with-your-skills) · [Docs](#docs)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
13
13
|
|
|
14
|
-
**Shadowclone
|
|
14
|
+
**Shadowclone brings your engineering preferences to every coding agent.** It maintains skills and instructions for Claude Code, Codex, Cursor, Pi, and Antigravity. Those preferences can evolve as Shadowclone learns from the sessions you allow.
|
|
15
|
+
|
|
16
|
+
**Skills, reviews, and delegated work.** Start with bundled skills and a build you configure. Review pull requests locally, read a guided review with your agent, or send work to a personal GitHub bot. The bot runs with your selected skills and your own Claude subscription or Codex credentials.
|
|
15
17
|
|
|
16
18
|
## Quick start
|
|
17
19
|
|
|
@@ -21,7 +23,7 @@ Paste this into Claude Code, Codex, Cursor, Pi, or Antigravity:
|
|
|
21
23
|
Set up Shadowclone: https://raw.githubusercontent.com/theonly1me/shadowclone/main/plugins/shadowclone/skills/setup-shadowclone/SKILL.md
|
|
22
24
|
```
|
|
23
25
|
|
|
24
|
-
The agent
|
|
26
|
+
The agent handles installation and configuration in about 5 minutes. You answer the consent questions and pick skills in the browser:
|
|
25
27
|
|
|
26
28
|
1. It installs the CLI, and the plugin in Claude Code or Codex.
|
|
27
29
|
2. It asks if Shadowclone can learn from your past sessions, keep skills in sync, and keep learning in the background.
|
|
@@ -43,14 +45,54 @@ To add the plugin, run `/plugin install shadowclone@shadowclone` after `/plugin
|
|
|
43
45
|
|
|
44
46
|
## What you get
|
|
45
47
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
48
|
+
### Preferences that evolve with your work
|
|
49
|
+
|
|
50
|
+
**Learn from corrections.** Shadowclone reads the sessions you allow and turns reusable instructions into skills and short native guidance. It keeps repository-specific rules in their scope. Rules remain readable, editable, and reversible.
|
|
51
|
+
|
|
52
|
+
**Keep guidance current.** Background learning reviews new rules after each session. It applies durable guidance when automatic maintenance is on and discards rules that existing guidance covers. You can review and undo each change. See the [learning guide](docs/guides/learning.md).
|
|
53
|
+
|
|
54
|
+
### Skills and builds you can configure
|
|
55
|
+
|
|
56
|
+
**Start with a build.** Shadowclone includes 15 workflow skills for planning, debugging, implementation, verification, and review. New users can pick skills immediately. Learning from past sessions is optional.
|
|
57
|
+
|
|
58
|
+
**Choose where skills apply.** The browser wizard supports a personal build, a private build for one repository, or a shared build that a team commits. The same skills reach all five agents. Pi can use any model it supports. See [Agent builds](docs/guides/agent-builds.md).
|
|
51
59
|
|
|
52
60
|
|
|
53
61
|
|
|
62
|
+
### Reviews on your machine and on GitHub
|
|
63
|
+
|
|
64
|
+
**Review a pull request.** Run a local review with your Claude subscription:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
shadowclone review 123
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
The reviewer combines repository standards, mechanical checks, and code analysis. Findings include evidence checked against the source. The result stays in a local file. Run `shadowclone review --base main` to review committed branch changes before opening a PR.
|
|
71
|
+
|
|
72
|
+
**Read a guided review.** Equip `guided-pr-review` and `shadowclone-review`, then ask your agent:
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
Use guided-pr-review to review PRs 1, 2, and 3.
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
The agent creates an HTML guide with actual diffs, behavior traces, and a reading order across the PRs. It supports inline notes and lets the reader reveal agent findings after forming a review. The guide stays local. See [reviews](docs/guides/reviews.md).
|
|
79
|
+
|
|
80
|
+
**Review in the cloud.** A configured cloud bot reviews eligible PRs or responds to a review mention. It posts findings on GitHub under its own identity. See [cloud review](docs/guides/reviews.md#review-in-the-cloud).
|
|
81
|
+
|
|
82
|
+
### A cloud bot with your skills
|
|
83
|
+
|
|
84
|
+
**Delegate GitHub work.** A personal bot runs in GitHub Actions with its owner's Claude subscription and selected skills. It works on issues, answers mentions, opens pull requests, and follows checks and review feedback. The owner decides when to merge. Codex is also supported.
|
|
85
|
+
|
|
86
|
+
**Ask the agent to configure it.** After local setup, ask:
|
|
87
|
+
|
|
88
|
+
```text
|
|
89
|
+
Set up Shadowclone cloud here with the bot octo-shadow.
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
The agent prepares the skills repository and workflows. The owner supplies the account credentials and merges the setup PR. The [cloud bot guide](docs/guides/cloud-bot.md) covers setup, Codex authentication, and pausing work to continue locally.
|
|
93
|
+
|
|
94
|
+
**Use the documented subscription path.** Anthropic documents Claude subscription authentication for GitHub Actions. Runs use the owner's subscription and GitHub Actions minutes. See [Claude subscriptions and terms](docs/guides/cloud-bot.md#claude-subscriptions-and-terms) for the official sources and usage boundaries.
|
|
95
|
+
|
|
54
96
|
## Skills in the box
|
|
55
97
|
|
|
56
98
|
Shadowclone bundles 15 workflow skills. Pick them in the wizard.
|
|
@@ -78,10 +120,6 @@ Use `--skill guided-pr-review shadowclone-review` to install guided review and i
|
|
|
78
120
|
The separate `@shadowclone/skills` npm artifact contains the same portable skills and supporting files.
|
|
79
121
|
See [manual installation](docs/guides/skills.md#install-skills-without-shadowclone).
|
|
80
122
|
|
|
81
|
-
The guided review skill creates an HTML reading route with real diffs, behaviour traces, and inline notes.
|
|
82
|
-
It connects related changes across PRs and identifies each change's PR.
|
|
83
|
-
See [guided reviews](docs/guides/reviews.md#guided-review-with-your-agent).
|
|
84
|
-
|
|
85
123
|
## Results
|
|
86
124
|
|
|
87
125
|
Across 24 fixed tasks, Shadowclone learning scored above existing user skills on all four models. Scores measure preference adherence on synthetic tasks. See [setups, methods, and limits](evals.md).
|