@zachcodingstream/engine

Core code intelligence engine with a lightweight CLI adapter.

Parse, index, and query relationships between functions, symbols, and files in JavaScript and TypeScript projects.

INSTALLATION

Install Globally (CLI)

npm install -g @zachcodingstream/engine

Then run:

zcs-cli

Install Locally (Library Usage)

npm install @zachcodingstream/engine

CLI USAGE

Ingest a File

zcs-cli ingest path/to/file.js

Ingest a Folder

zcs-cli ingest path/to/project/

Supported Extensions:

• .js
• .ts
• .jsx
• .tsx
• .py

Query a Symbol

zcs-cli query MyFunction

Returns:

• Symbol details
• Callers
• Callees
• Related symbols in the same file

Lifecycle Commands

zcs-cli lifecycle clear zcs-cli lifecycle reset zcs-cli lifecycle rebuild

clear → clears runtime relationships reset → wipes entire project index rebuild → rebuilds from snapshot

PROGRAMMATIC USAGE

Example:

const projectIndex = require("@zachcodingstream/engine/core/projectIndex"); const fileParser = require("@zachcodingstream/engine/core/fileParser");

const content = "..."; const parsed = fileParser.parseFile("example.js", content); projectIndex.upsertFile("example.js", parsed);

ARCHITECTURE

The engine is separated into layers:

core/ projectIndex.js fileParser.js queryHandler.js

adapters/ cli/

• core contains all business logic
• adapters expose that logic externally
• no business logic lives in the CLI

This allows future adapters such as:

• HTTP APIs
• Desktop applications
• Editor integrations
• Remote indexing services

VERSIONING

Current version: 0.0.1

This project is in early development. Breaking changes may occur before 1.0.0.

LICENSE

MIT © ZachCodingStream

See LICENSE file for full text.

CONTRIBUTING

Pull requests and improvements are welcome.

If you build something interesting with the engine, feel free to share.