Getting Started

What Forge Does

Forge generates Teamcenter ITK C++ batch programs from natural-language requests.

Current shipped generation scope:

artifact type: itk-batch
patterns: file-input-mutate, query-export, query-update, simple-operation

Generated output includes:

a primary .cxx file
build.sh
build.bat

Web Workflow

Open the sign-in page.
Enter your email address.
Use the magic link sent to your inbox.
Open the generator.
Select the batch pattern that best matches the task.
Enter the request and Teamcenter context.
Follow the stage stream while Forge plans, loads knowledge-base context, generates, validates, and packages the result.
Review files and diagnostics.
Download the ZIP archive.

CLI Status

Forge includes a CLI implementation in this repo for local development and internal evaluation.

It is not yet publicly available as a self-serve customer surface.

Current public onboarding is the web workflow above.

If you are working inside this repository, the CLI can be exercised locally:

node apps/cli/dist/index.js init my-project
node apps/cli/dist/index.js login <forge-api-key>
node apps/cli/dist/index.js generate "Export released parts to CSV"

Run generate from the project directory created by forge init. The repo-local CLI writes returned files into that project using the configured output paths.

Repo-Local CLI Project Layout

forge init creates:

forge.yaml
src/
input/
build/
.gitignore
README.md

forge.yaml carries environment context such as Teamcenter version, compiler, output directory, code prefix, and branding metadata.

Before You Build Or Run

review generated code
verify the target Teamcenter version and compiler settings
test in a controlled environment first
use dry-run behavior when the generated batch supports it

Forge generates source artifacts. Build, deployment, and execution remain the responsibility of the engineering team using the output.