arcshape 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,92 @@
-# Temporary Holding Version
+# ArcShape
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+ArcShape is an npm-installable CLI and a set of AI workflows for creating and maintaining Markdown architecture documentation with [arc42](https://arc42.org/). Its generated reader site is designed for technical and non-technical readers.
+
+Browse the [ArcShape architecture site](https://juangcarmona.github.io/arcshape/).
+
+## Get started
+
+After the first npm release, install ArcShape in a project repository with Node.js 22 or newer and run:
+
+```sh
+npm install --save-dev arcshape
+npx arcshape init
+```
+
+This creates `docs/architecture/` with a README and the twelve arc42 sections, and installs ArcShape skills for Codex and Claude under `.agents/skills/` and `.claude/skills/`, plus Claude slash commands under `.claude/commands/arcshape/`. In Codex, invoke a skill with its `$arcshape-*` name. Initialization is repeatable and never overwrites different existing files. Use `npx arcshape init --dry-run` to preview the files, or `npx arcshape init --target ../my-project` to select a repository directory.
+
+The CLI provides repository setup (`init`), resumable evidence-round bookkeeping (`session`), arc42 Markdown structure, local-link and optional ProductShape citation validation (`validate`), Obsidian and Confluence sync (`sync`), and a self-contained reader site (`site build`). Codex and Claude skills cover reverse engineering, arc42 authoring, ADRs, C4 diagrams, and documentation connections; Claude also receives matching slash commands.
+
+Validate arc42 structure and local links. Add `--citations` to verify ProductShape citations when the repository has a model at `docs/product/model`:
+
+```sh
+npx arcshape validate --links --citations
+```
+
+Citation validation uses the repository's installed `@prodshape/cli`; install it when a ProductShape model is present. Without a model, citation validation is reported as skipped. Stale citations appear as warnings, while unresolved citations or a missing local CLI fail validation.
+
+Start a local analysis session and ask for its next bounded evidence round:
+
+```sh
+npx arcshape session start
+npx arcshape session next
+```
+
+Copy the canonical Markdown into an Obsidian vault:
+
+```sh
+npx arcshape sync obsidian --vault ~/Documents/ObsidianVault --include docs/adr --dry-run
+npx arcshape sync obsidian --vault ~/Documents/ObsidianVault --include docs/adr
+```
+
+The sync stores a local manifest beside the exported notes, updates copies only while they still match the last ArcShape version, and reports local edits as conflicts.
+
+To publish architecture as an index with one child page per arc42 section, choose a Confluence parent page and set credentials in environment variables. Preview the page plan first:
+
+```sh
+CONFLUENCE_EMAIL=you@example.com CONFLUENCE_API_TOKEN=... \
+  npx arcshape sync confluence \
+  --base-url https://example.atlassian.net/wiki \
+  --space-id 12345 --parent-id 123456 --title-prefix MyProject \
+  --include docs/adr --dry-run
+```
+
+Remove `--dry-run` to create or update the pages. ArcShape records a local baseline in `.arcshape/confluence-sync/`; later runs stop on remote edits to managed pages. For a single-page destination, use `--page-id <id>` instead of `--space-id` and `--parent-id`.
+
+The session tool inventories files without selecting by programming language and honors root and nested `.gitignore` rules, including negations. It records the human or AI workflow's classifications and notes; it does not read findings into architecture claims by itself.
+
+## Project foundations
+
+- The approved product definition belongs in `docs/product/model` and is managed with [ProductShape](https://github.com/juangcarmona/productshape).
+- Architecture documentation will live under `docs/architecture` and follow [arc42](https://arc42.org/).
+- [OpenSpec](https://github.com/Fission-AI/OpenSpec) is used for temporary delivery planning, not as a source of product or architecture truth.
+- Read the [engineering lifecycle](docs/engineering-lifecycle.md) for issue readiness, review, and merge expectations.
+
+## Development setup
+
+Requirements: [Node.js](https://nodejs.org/) 22 or newer and [npm](https://www.npmjs.com/).
+
+```sh
+npm ci
+```
+
+The pinned [ProductShape](https://github.com/juangcarmona/productshape) and [OpenSpec](https://github.com/Fission-AI/OpenSpec) CLIs are installed as local development dependencies. Use `npx prodshape <command>` or the package scripts to run them; global installation is not required.
+
+The tracked Codex, Claude, [ProductShape](https://github.com/juangcarmona/productshape), and [OpenSpec](https://github.com/Fission-AI/OpenSpec) integrations are already present in this development repository. Run these only when intentionally regenerating or refreshing the corresponding integration files:
+
+```sh
+npm run product:init
+npm run openspec:init
+```
+
+The initial quality baseline is defined in the [engineering lifecycle](docs/engineering-lifecycle.md). `npm run build` compiles repository helper scripts; it is not the ArcShape CLI build.
+
+## Contributing
+
+Start with the [contribution guide](CONTRIBUTING.md). For non-trivial work, open or refine a GitHub issue before planning implementation.
+
+Release preparation, the first npm publication, and later trusted publishing are documented in [Releasing ArcShape](docs/releasing.md).
+
+## License
+
+ArcShape is licensed under the [Apache License, Version 2.0](LICENSE), the same license used by [ProductShape](https://github.com/juangcarmona/productshape).

package/bin/arcshape.mjs

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+
+import { readFile } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+import { dirname, join } from "node:path";
+import { runInit } from "./init.mjs";
+import { runSite } from "./site.mjs";
+import { runSession } from "./session.mjs";
+import { runValidate } from "./validate.mjs";
+import { runSync } from "./sync.mjs";
+
+const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)));
+const packageJson = JSON.parse(
+  await readFile(join(packageRoot, "package.json"), "utf8"),
+);
+const [command, ...args] = process.argv.slice(2);
+
+if (command === "--version" || command === "-v") {
+  process.stdout.write(`${packageJson.version ?? "0.0.0"}\n`);
+} else if (command === "--help" || command === "-h" || command === undefined) {
+  printHelp();
+} else if (command === "init") {
+  try {
+    const result = await runInit(args, { packageRoot });
+    process.exitCode = result.exitCode;
+  } catch (error) {
+    process.stderr.write(`arcshape init: ${error.message}\n`);
+    process.exitCode = 2;
+  }
+} else if (command === "site") {
+  try {
+    const result = await runSite(args, { packageRoot });
+    process.exitCode = result.exitCode;
+  } catch (error) {
+    process.stderr.write(`arcshape site: ${error.message}\n`);
+    process.exitCode = 2;
+  }
+} else if (command === "session") {
+  try {
+    const result = await runSession(args);
+    process.exitCode = result.exitCode;
+  } catch (error) {
+    process.stderr.write(`arcshape session: ${error.message}\n`);
+    process.exitCode = 2;
+  }
+} else if (command === "validate") {
+  try {
+    const result = await runValidate(args);
+    process.exitCode = result.exitCode;
+  } catch (error) {
+    process.stderr.write(`arcshape validate: ${error.message}\n`);
+    process.exitCode = 2;
+  }
+} else if (command === "sync") {
+  try {
+    const result = await runSync(args);
+    process.exitCode = result.exitCode;
+  } catch (error) {
+    process.stderr.write(`arcshape sync: ${error.message}\n`);
+    process.exitCode = 2;
+  }
+} else {
+  process.stderr.write(`Unknown command: ${command}\n\n`);
+  printHelp(process.stderr);
+  process.exitCode = 2;
+}
+
+function printHelp(stream = process.stdout) {
+  stream.write(`ArcShape CLI\n\n`);
+  stream.write(`Usage: arcshape <command> [options]\n\n`);
+  stream.write(`Commands:\n`);
+  stream.write(
+    `  init [--target <directory>] [--dry-run]  Set up Markdown docs and AI workflows\n`,
+  );
+  stream.write(
+    `  site build [--docs <directory>] [--out <file>]  Render the Markdown reader site\n`,
+  );
+  stream.write(
+    `  validate [--docs <directory>] [--links] [--citations]  Validate docs, links, and citations\n`,
+  );
+  stream.write(
+    `  sync obsidian|confluence [options]         Sync Markdown to Obsidian or Confluence\n`,
+  );
+  stream.write(
+    `  session <command>                         Track evidence rounds and resume analysis\n`,
+  );
+  stream.write(
+    `  --help, --version                        Show help or the installed version\n\n`,
+  );
+  stream.write(
+    `Run arcshape init from any repository directory. Existing files are preserved.\n`,
+  );
+}