@forwardimpact/guide 0.1.5

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 the 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 2026 Dick Olsson
+
+   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

@@ -0,0 +1,94 @@
+# @forwardimpact/guide
+
+> How do I find my bearing?
+
+Guide is an AI agent that understands your organization's engineering framework
+— skills, levels, behaviours, and expectations — and reasons about them in
+context. It helps developers onboard, find growth areas, and interpret
+engineering artifacts against skill markers.
+
+Guide is part of the [Forward Impact](https://www.forwardimpact.team) product
+suite alongside [Map](https://www.npmjs.com/package/@forwardimpact/map),
+[Pathway](https://www.npmjs.com/package/@forwardimpact/pathway), Basecamp,
+Landmark, and Summit.
+
+## Install
+
+```sh
+bun install @forwardimpact/guide
+```
+
+## Service Requirements
+
+Guide is a client for the Forward Impact knowledge platform. Unlike Map (local
+YAML validation) and Pathway (local job derivation), Guide connects to a gRPC
+service stack for LLM orchestration, memory, knowledge graphs, and vector
+search.
+
+The following services must be running:
+
+- **agent** — orchestrates multi-turn conversations
+- **llm** — provides LLM completions
+- **memory** — manages conversation history
+- **graph** — stores knowledge graph triples
+- **vector** — provides embedding similarity search
+- **tool** — executes tool calls
+- **trace** — records execution traces
+- **web** — serves web interface
+
+## Quick Start
+
+1. Clone the monorepo and start the service stack:
+
+   ```sh
+   git clone https://github.com/forwardimpact/monorepo
+   cd monorepo
+   make services
+   ```
+
+2. Set the service secret in your environment:
+
+   ```sh
+   export SERVICE_SECRET=<your-secret>
+   ```
+
+3. Run Guide:
+
+   ```sh
+   bunx fit-guide
+   ```
+
+## CLI Usage
+
+```sh
+# Start an interactive conversation
+bunx fit-guide
+
+# Pipe a question directly
+echo "Tell me about the company" | bunx fit-guide
+
+# Specify a framework data directory
+bunx fit-guide --data=./my-data
+
+# Show help
+bunx fit-guide --help
+
+# Show version
+bunx fit-guide --version
+```
+
+## Related Packages
+
+- [@forwardimpact/map](https://www.npmjs.com/package/@forwardimpact/map) —
+  Engineering framework validation and data product
+- [@forwardimpact/pathway](https://www.npmjs.com/package/@forwardimpact/pathway)
+  — Career progression web app and CLI
+
+## Documentation
+
+- [Guide product page](https://www.forwardimpact.team/guide)
+- [Monorepo](https://github.com/forwardimpact/monorepo)
+
+## License
+
+Apache-2.0

package/bin/fit-guide.js

@@ -0,0 +1,179 @@
+#!/usr/bin/env bun
+/**
+ * fit-guide CLI
+ *
+ * Conversational agent interface for the Guide knowledge platform.
+ *
+ * Usage:
+ *   bunx fit-guide
+ *   echo "Tell me about the company" | bunx fit-guide
+ */
+
+import { resolve } from "path";
+import fs from "fs/promises";
+import { homedir } from "os";
+
+// --help flag (works without SERVICE_SECRET)
+if (process.argv.includes("--help") || process.argv.includes("-h")) {
+  console.log(`fit-guide — Conversational agent for the Guide knowledge platform
+
+Usage:
+  bunx fit-guide                   Start interactive conversation
+  bunx fit-guide --data=<path>     Specify framework data directory
+  echo "question" | bunx fit-guide Pipe a question directly
+
+Options:
+  --data=<path>   Path to framework data directory
+  --help, -h      Show this help message
+  --version, -v   Show version
+
+Guide connects to the Forward Impact service stack to provide
+AI-powered guidance grounded in your engineering framework.
+
+Documentation: https://www.forwardimpact.team/guide`);
+  process.exit(0);
+}
+
+// --version flag (works without SERVICE_SECRET)
+if (process.argv.includes("--version") || process.argv.includes("-v")) {
+  const { version } = JSON.parse(
+    await fs.readFile(new URL("../package.json", import.meta.url), "utf8"),
+  );
+  console.log(version);
+  process.exit(0);
+}
+
+// SERVICE_SECRET gate — provide onboarding instructions instead of a cryptic error
+if (!process.env.SERVICE_SECRET) {
+  console.log(`fit-guide — Conversational agent for the Guide knowledge platform
+
+Guide requires a running service stack to function. The following
+services must be available:
+
+  agent, llm, memory, graph, vector, tool, trace, web
+
+To get started:
+
+  1. Clone the monorepo and run: make services
+  2. Set SERVICE_SECRET in your environment
+  3. Run: bunx fit-guide
+
+Documentation: https://www.forwardimpact.team/guide
+Run bunx fit-guide --help for CLI options.`);
+  process.exit(1);
+}
+
+import { createServiceConfig } from "@forwardimpact/libconfig";
+import { Repl } from "@forwardimpact/librepl";
+import { createClient, createTracer } from "@forwardimpact/librpc";
+import { createLogger } from "@forwardimpact/libtelemetry";
+import { agent, common } from "@forwardimpact/libtype";
+import { createStorage } from "@forwardimpact/libstorage";
+import { Finder } from "@forwardimpact/libutil";
+
+const usage = `**Usage:** <message>
+
+Send conversational messages to the Agent service for processing.
+The agent maintains conversation context across multiple turns.
+
+**Examples:**
+
+    echo "Tell me about the company" | bunx fit-guide
+    printf "What is microservices?\\nWhat are the benefits?\\n" | bunx fit-guide`;
+
+// Parse --data flag from CLI args
+const dataArg = process.argv.find((a) => a.startsWith("--data="));
+let dataDir;
+if (dataArg) {
+  dataDir = resolve(dataArg.slice(7));
+} else {
+  const guideLogger = createLogger("cli");
+  const finder = new Finder(fs, guideLogger, process);
+  try {
+    dataDir = finder.findData("data", homedir());
+  } catch {
+    throw new Error(
+      "No data directory found. Use --data=<path> to specify location.",
+    );
+  }
+}
+
+try {
+  const config = await createServiceConfig("agent");
+  const logger = createLogger("cli");
+  const tracer = await createTracer("cli");
+  const agentClient = await createClient("agent", logger, tracer);
+
+  // Create storage for persisting REPL state
+  const storage = createStorage("cli");
+
+  /**
+   * Handles user prompts by adding them to message history,
+   * sending to the Agent service, and returning the response
+   * @param {string} prompt - The user's input prompt
+   * @param {object} state - The REPL state object
+   * @param {import("stream").Writable} outputStream - Stream to write results to
+   */
+  async function handlePrompt(prompt, state, outputStream) {
+    try {
+      // Create user message - content is just a string
+      const userMessage = common.Message.fromObject({
+        role: "user",
+        content: prompt,
+      });
+
+      // Create typed request using agent.AgentRequest
+      const request = agent.AgentRequest.fromObject({
+        messages: [userMessage],
+        llm_token: await config.llmToken(),
+        resource_id: state.resource_id,
+        model: config.model,
+        agent: config.agent,
+      });
+
+      const stream = agentClient.ProcessStream(request);
+
+      for await (const response of stream) {
+        if (response.resource_id) {
+          state.resource_id = response.resource_id;
+        }
+        if (response.messages?.length > 0) {
+          const text = response.messages.map((msg) => msg.content).join("\n");
+          outputStream.write(text);
+        }
+      }
+    } catch (err) {
+      logger.exception("ProcessStream", err);
+      throw err;
+    }
+  }
+
+  // Create REPL with dependency injection
+  const repl = new Repl({
+    usage,
+    storage,
+    state: {
+      resource_id: null,
+      dataDir,
+    },
+    onLine: handlePrompt,
+    afterLine: (state) => {
+      return logger.debug("ProcessStream", "Stream ended", {
+        resource_id: state.resource_id,
+      });
+    },
+  });
+
+  repl.start();
+} catch (err) {
+  console.error(`Failed to connect to the Guide service stack.
+
+Error: ${err.message}
+
+Ensure all required services are running:
+  agent, llm, memory, graph, vector, tool, trace, web
+
+For local development: make services
+Documentation: https://www.forwardimpact.team/guide`);
+  process.exit(1);
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@forwardimpact/guide",
+  "version": "0.1.5",
+  "description": "Conversational agent for engineering framework guidance — How do I find my bearing?",
+  "license": "Apache-2.0",
+  "author": "D. Olsson <hi@senzilla.io>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/forwardimpact/monorepo",
+    "directory": "products/guide"
+  },
+  "homepage": "https://www.forwardimpact.team/guide",
+  "keywords": [
+    "engineering-framework",
+    "career-development",
+    "ai-agent",
+    "skill-assessment",
+    "knowledge-platform",
+    "conversational-agent",
+    "engineering-excellence",
+    "rag"
+  ],
+  "type": "module",
+  "bin": {
+    "fit-guide": "./bin/fit-guide.js"
+  },
+  "files": [
+    "bin/",
+    "README.md"
+  ],
+  "engines": {
+    "bun": ">=1.2.0"
+  },
+  "dependencies": {
+    "@forwardimpact/libconfig": "^0.1.58",
+    "@forwardimpact/librepl": "^0.1.0",
+    "@forwardimpact/libutil": "^0.1.64",
+    "@forwardimpact/librpc": "^0.1.77",
+    "@forwardimpact/libstorage": "^0.1.53",
+    "@forwardimpact/libtelemetry": "^0.1.22",
+    "@forwardimpact/libtype": "^0.1.63"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}