@intellectual-frontiers/ergonex 0.0.0-stage → 0.2.3
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/CREDITS.md +34 -0
- package/LICENSE +21 -0
- package/README.md +10 -2
- package/ergonex.mjs +12294 -0
- package/package.json +36 -4
package/CREDITS.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Credits
|
|
2
|
+
|
|
3
|
+
Intellectual Frontiers Workspaces (Ergonex, the `ergonex` command) stands on the work of others. This file names them, as `0002-workspace-model` FR-046 requires. Nothing here is a claim that any of them endorses Ergonex.
|
|
4
|
+
|
|
5
|
+
## The earlier workspace tools
|
|
6
|
+
|
|
7
|
+
The layout of Ergonex (one root with the repositories placed as their remotes are named), and the ideas of `ensure` (bring the workspace to the state it should be in, and do it again without harm), `status` (one look at every repository) and `doctor` (what is wrong, what is only worth a look, and what to do) come from the earlier workspace tools of Intellectual Frontiers' founder, **Shahid Shah**. Those tools are kept private and nothing of them is in this repository but this credit. Ergonex carries the behavior on in TypeScript, adds a plan that is shown before anything is done, never deletes work that is not pushed, and keeps its own evidence.
|
|
8
|
+
|
|
9
|
+
## chezmoi
|
|
10
|
+
|
|
11
|
+
[chezmoi](https://www.chezmoi.io/), by **Tom Payne and contributors** (MIT license), is the inspiration for these ideas, and only the ideas:
|
|
12
|
+
|
|
13
|
+
- a **source state** and a **target state** (here the typed manifest and the plan made from it);
|
|
14
|
+
- **templates over data** (here typed TypeScript functions that generate the `*.auto.*` files, not a template language);
|
|
15
|
+
- the commands `apply`, `diff`, `status` and `verify`;
|
|
16
|
+
- a **state record**, so that a hand edit or a drift can be seen (`state.auto.json`).
|
|
17
|
+
|
|
18
|
+
No chezmoi code, template, data file or program is used, called or required by Ergonex (`0003-host` FR-021), and Ergonex is not a dotfiles manager: it manages the workspace and never edits a person's home folder or global Git configuration.
|
|
19
|
+
|
|
20
|
+
## Git
|
|
21
|
+
|
|
22
|
+
[Git](https://git-scm.com/) is run for every repository operation, and its convention that `git foo` runs the program `git-foo` on the `PATH` is the model of the `ergonex` controller, which runs `ergonex-<name>` modules found among its built-in modules, the modules a workspace registers and executables named `ergonex-*` on the `PATH`.
|
|
23
|
+
|
|
24
|
+
## Standards and vocabularies
|
|
25
|
+
|
|
26
|
+
Where a standard exists Ergonex takes it before inventing a term (`0018-standards-first`). The ones used here:
|
|
27
|
+
|
|
28
|
+
- **NIST SP 800-53 Rev. 5** (configuration management, CM family) and the **NIST OSCAL** models, for the controls the workspace's evidence speaks to; the **FedRAMP** baselines are the first domain.
|
|
29
|
+
- **PROV-O** (W3C), for plans and activities, and **DCAT** (W3C), for catalogs.
|
|
30
|
+
- **SARIF** (OASIS), the form in which the findings of Ergonex are rendered.
|
|
31
|
+
- **OpenTelemetry**, the form in which the records of a run are written, through the evidence record of the quality system (`0021-ifqs`).
|
|
32
|
+
- **Git's own signature formats** (OpenPGP and SSH), for the signed commits that a harness with a declared regulated domain requires.
|
|
33
|
+
- **SPDX** 2.3 and **CycloneDX** 1.6, with OSCAL `inventory-item`, the forms in which the tool catalog and the inventory of installed tools are written for an assessor.
|
|
34
|
+
- **RFC 2119** and **EARS**, for the requirements of the specifications.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Intellectual Frontiers
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Ergonex
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The workspaces management of Intellectual Frontiers: one command, `ergonex`, that sets up and operates a team's repositories, tools and shell on Windows, macOS and Linux.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
bunx @intellectual-frontiers/ergonex init # with Bun; with Node 26: npx @intellectual-frontiers/ergonex init
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
It makes the workspace folder, puts `ergonex` on your path and says what to do next. `ergonex doctor` checks the workspace and says what to fix.
|
|
10
|
+
|
|
11
|
+
The sources and the specifications are in https://github.com/intellectual-frontiers/.github/tree/main/commons/ergonex
|