@scalequality/cli 0.4.0 → 0.4.2

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
@@ -1,8 +1,9 @@
1
1
  # @scalequality/cli
2
2
 
3
- Run the ScaleQuality AI Workspace coding engine on your own machine, in your
4
- repository folders. The conversation stays in the browser; the files, the
5
- commands and the git working tree stay on your computer.
3
+ Run the ScaleQuality AI Workspace coding engine on your own machine, in any
4
+ folder: a git repository, a folder inside one, or a folder with several
5
+ repositories and other files. The conversation stays in the browser; the files,
6
+ the commands and the git working trees stay on your computer.
6
7
 
7
8
  ## Connect this computer
8
9
 
@@ -121,8 +122,23 @@ Workspace screen: it runs one session in the current folder (`--dir PATH`,
121
122
  `--api URL`, `--verbose`) and ends when you press Ctrl+C twice. It is not listed
122
123
  in the help: `login` replaces it.
123
124
 
124
- Requires Node.js 18 or newer and git. A folder must be the root of a git
125
- repository; the CLI never runs `git init`, clones or fetches for you.
125
+ Requires Node.js 18 or newer and git. Any folder works; the CLI never runs
126
+ `git init`, clones or fetches for you.
127
+
128
+ ## Any folder
129
+
130
+ - **A git repository**: its change is compared with `HEAD`.
131
+ - **A folder inside a repository**: the engine works in that folder; the
132
+ repository tracks its change (only that folder's files).
133
+ - **A folder that is not a repository** (for example `~/GIT` with many
134
+ repositories inside): the repositories in it are found (up to 4 levels down,
135
+ skipping `node_modules`, build output and hidden folders) and each one keeps
136
+ its own change against its own `HEAD`. Files outside every repository are
137
+ copied before the engine first changes them, into
138
+ `~/.scalequality/workspace/sessions/` (never into your folder), so you can
139
+ review, discard or rewind those changes too. Copies of sessions unused for 30
140
+ days are removed. Changes made by shell commands to files outside a
141
+ repository are not tracked.
126
142
 
127
143
  ## What runs where
128
144
 
@@ -132,8 +148,9 @@ On your machine:
132
148
  the folder**;
133
149
  - the commands it wants to run, **each one after you approve it in the
134
150
  browser** (or after an "always allow" rule you created covers it);
135
- - the diff of your folder against `HEAD` at connect time, which is what the
136
- browser shows and what a pull request carries.
151
+ - the diff of each repository against its `HEAD` at connect time (and of the
152
+ other files against their copies), which is what the browser shows and what
153
+ a pull request carries.
137
154
 
138
155
  In ScaleQuality:
139
156
 
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "sdkVersion": "0.3.281",
3
- "sha256": "e6387aaa87dedbc6a119b7f0d9a10690acc966a76b5453a6f573efdc051f8c46",
4
- "sourceCommit": "e37bac1d879b18a3094b9fdc9d813efa1f115280"
3
+ "sha256": "e6408c8711d5f8ce5fa0fc528835a2bb1f859c6e220f4a1757f8330a88b639dc",
4
+ "sourceCommit": "98b4ef0ee422519ddd7767944a68147c22d33466"
5
5
  }