create-filegrc 0.3.4 → 0.4.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.
- package/README.md +4 -3
- package/package.json +1 -1
- package/src/cli.js +5 -3
- package/src/defaults.js +81 -112
- package/src/index.js +13 -12
- package/template/AGENTS.md +23 -16
- package/template/README.md +10 -7
- package/template/data/AGENTS.md +35 -13
- package/template/data/action-items/AGENTS.md +2 -2
- package/template/data/appointments/appointment-policy-owner.json +11 -0
- package/template/data/audits/AGENTS.md +1 -1
- package/template/data/documents/document-business-continuity-disaster-recovery.json +12 -12
- package/template/data/documents/document-business-continuity-disaster-recovery.md +1 -1
- package/template/data/documents/document-contractor-policy-acknowledgement.json +10 -11
- package/template/data/documents/document-contractor-training-acknowledgement.json +13 -12
- package/template/data/documents/document-data-retention-schedule.json +9 -11
- package/template/data/documents/document-employee-handbook-acknowledgement.json +10 -11
- package/template/data/documents/document-employee-policy-acknowledgement.json +10 -11
- package/template/data/documents/document-employee-training-acknowledgement.json +13 -12
- package/template/data/documents/document-incident-response-plan.json +12 -12
- package/template/data/documents/document-incident-response-plan.md +2 -2
- package/template/data/documents/document-soc2-management-assertion.json +2 -3
- package/template/data/documents/document-soc2-management-representation.json +2 -3
- package/template/data/documents/document-soc2-period-completeness.json +2 -3
- package/template/data/documents/document-soc2-system-description.json +2 -3
- package/template/data/evidence/AGENTS.md +3 -3
- package/template/data/obligation-events/AGENTS.md +2 -2
- package/template/data/obligations/AGENTS.md +1 -1
- package/template/data/people/person-program-lead.json +9 -0
- package/template/data/policies/AGENTS.md +1 -1
- package/template/data/policies/policy-anti-bribery-corruption.json +9 -15
- package/template/data/policies/policy-anti-bribery-corruption.md +1 -1
- package/template/data/policies/policy-clear-desk-screen.json +8 -14
- package/template/data/policies/policy-clear-desk-screen.md +1 -1
- package/template/data/policies/policy-data-protection-handling.json +10 -22
- package/template/data/policies/policy-data-protection-handling.md +2 -2
- package/template/data/policies/policy-employee-handbook.json +6 -16
- package/template/data/policies/policy-information-security.json +8 -40
- package/template/data/policies/policy-information-security.md +2 -2
- package/template/data/policies/policy-mobile-computing-communications.json +8 -18
- package/template/data/policies/policy-mobile-computing-communications.md +1 -1
- package/template/data/renderer.json +0 -1
- package/template/data/training/training-anti-bribery-high-risk-roles.json +1 -2
- package/template/data/training/training-privileged-sensitive-roles.json +1 -2
- package/template/data/training/training-secure-development.json +1 -2
- package/template/data/training/training-security-awareness.json +7 -9
- package/template/data/training/training-security-awareness.md +1 -1
- package/template/data/workspace.json +19 -8
- package/template/docs/filegrc-home.png +0 -0
- package/template/package.json +1 -1
- package/template-parameters.json +6 -1
- package/template/data/people/person-policy-owner.json +0 -10
package/README.md
CHANGED
|
@@ -9,9 +9,9 @@ npm run validate
|
|
|
9
9
|
npm run serve
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Setup asks for the legal organization name, the initial
|
|
12
|
+
Setup asks for the legal organization name, the initial program lead and their organization job title and email, a security reporting address, and the program timezone. The generated Person records the lead’s actual position, while a separate dated Policy Owner Appointment owns the starter work. The generated private project includes a starter Security program, Program Readiness, a policy-driven Work Queue, Policy Events that add linked tasks, later audit preparation, evidence packets, and one dependency: `filegrc`.
|
|
13
13
|
|
|
14
|
-
Creation has two layers. The
|
|
14
|
+
Creation has two layers. The six-record foundation contains workspace settings, the initial program lead, the Policy Owner Appointment, the oversight team, renderer settings, and the filegrc system of record. The default `security` starter adds the framework references, proposed policies, controls, obligations, documents, and training records. Pass `--starter foundation` when you want to stop before selecting a framework.
|
|
15
15
|
|
|
16
16
|
For one noninteractive run, pass company and service fields together or use `--config setup.json`. The optional `setup` object defines the service boundary and management goal after installation. Use `--filegrc-package <directory>` to exercise unpublished local engine changes instead of installing the registry release. This writes a machine-local `file:` dependency, so replace it with a released version before sharing the generated workspace.
|
|
17
17
|
|
|
@@ -19,6 +19,7 @@ For one noninteractive run, pass company and service fields together or use `--c
|
|
|
19
19
|
{
|
|
20
20
|
"companyName": "Example Company",
|
|
21
21
|
"policyOwnerName": "Security Owner",
|
|
22
|
+
"policyOwnerJobTitle": "Chief Executive Officer",
|
|
22
23
|
"policyOwnerEmail": "owner@example.com",
|
|
23
24
|
"securityContactEmail": "security@example.com",
|
|
24
25
|
"timezone": "America/Chicago",
|
|
@@ -38,7 +39,7 @@ For one noninteractive run, pass company and service fields together or use `--c
|
|
|
38
39
|
npx create-filegrc@latest company-grc --config setup.json
|
|
39
40
|
```
|
|
40
41
|
|
|
41
|
-
Generated workspaces also include layered `AGENTS.md` instructions and model-driven headless commands. `filegrc program-path` gives agents the same
|
|
42
|
+
Generated workspaces also include layered `AGENTS.md` instructions and model-driven headless commands. `filegrc program-path` gives agents the same five steps, exact page guidance, current status, and next actions shown in the renderer. Agents can define program scope, approve policies, implement controls and their evidence sources, complete policy work, trigger event tasks, and prepare later audit packets through the same domain functions used by the renderer.
|
|
42
43
|
|
|
43
44
|
Git is initialized on `main` when needed. New workspaces use trunk mode with `main` and `origin`. Browser editing becomes available after that branch has an upstream; each save fast-forwards, validates, commits, and pushes automatically. Existing parent repositories are supported and never receive a nested Git repository.
|
|
44
45
|
|
package/package.json
CHANGED
package/src/cli.js
CHANGED
|
@@ -118,6 +118,7 @@ function parseArgs(argv) {
|
|
|
118
118
|
else if (name === "config") options.config = next();
|
|
119
119
|
else if (name === "company-name") options.companyName = next();
|
|
120
120
|
else if (name === "policy-owner-name") options.policyOwnerName = next();
|
|
121
|
+
else if (name === "policy-owner-job-title") options.policyOwnerJobTitle = next();
|
|
121
122
|
else if (name === "policy-owner-email") options.policyOwnerEmail = next();
|
|
122
123
|
else if (name === "security-contact-email") options.securityContactEmail = next();
|
|
123
124
|
else if (name === "timezone") options.timezone = next();
|
|
@@ -131,7 +132,7 @@ function parseArgs(argv) {
|
|
|
131
132
|
else if (name === "boundary") setup.boundary = next();
|
|
132
133
|
else if (name === "service-owner") setup.ownerId = next();
|
|
133
134
|
else if (name === "criticality") setup.criticality = next();
|
|
134
|
-
else if (name === "classification") setup.
|
|
135
|
+
else if (name === "classification") setup.classificationId = next();
|
|
135
136
|
else if (name === "internet-exposed") setup.internetExposed = booleanOption(next(), "internet-exposed");
|
|
136
137
|
else if (name === "program-goal") setup.programGoal = next();
|
|
137
138
|
else if (name === "setup-draft") setup.draft = true;
|
|
@@ -148,7 +149,8 @@ Create a filegrc workspace for a SOC 2 program.
|
|
|
148
149
|
Options:
|
|
149
150
|
--config <json-file|-> Read creation and optional setup values
|
|
150
151
|
--company-name <legal-name> Legal organization name
|
|
151
|
-
--policy-owner-name <name> Initial
|
|
152
|
+
--policy-owner-name <name> Initial program lead
|
|
153
|
+
--policy-owner-job-title <title> Program lead's organization job title
|
|
152
154
|
--policy-owner-email <email> Policy owner's email address
|
|
153
155
|
--security-contact-email <email> Security reporting address
|
|
154
156
|
--timezone <iana-timezone> Program timezone, such as America/Chicago
|
|
@@ -160,7 +162,7 @@ Options:
|
|
|
160
162
|
--repository-remote <name> Browser sync remote, defaults to origin
|
|
161
163
|
--service-name <name> Complete service setup after creation
|
|
162
164
|
--boundary <description> Initial service boundary
|
|
163
|
-
--service-owner <person-id> Defaults to person-
|
|
165
|
+
--service-owner <person-id> Defaults to person-program-lead
|
|
164
166
|
--criticality <level> low, medium, high, or critical
|
|
165
167
|
--classification <name> Initial data classification
|
|
166
168
|
--internet-exposed <bool> true or false
|