Skip to main content
engframe is a small command-line tool for adding content to the Knowledge Base without opening the dashboard. Log in once with your browser, then ingest a Markdown file straight from your terminal or a script.
This is a separate, general-purpose tool from the Knowledge Base MCP Server — that’s for connecting an AI assistant like Claude Code to search and read the Knowledge Base. engframe is something you (or a script) run directly, and today it only does one thing: ingest. More commands will be added over time.

​
Install

This installs an engframe command on your PATH. Requires Node.js 20 or later. If you’d rather not install globally, npx @engineeringframework/cli <command> works the same way without installing anything permanently.

​
Log in

This opens your default browser to sign in. After you log in, engframe stores a token on your machine so you don’t need to log in again until it expires — if it does, the next command will tell you to run engframe login again. By default, engframe connects to the hosted Knowledge Base. If your organization runs its own deployment, pass its URL explicitly, or set it once as an environment variable:

​
Ingest a document

On success, this prints the new Document’s ID and status. New Documents always start as draft — never automatically published — so it’ll need review before it shows up in search. See The Document Review Workflow.
If something’s wrong with the file — an unknown project, an unknown domain, or a link to a Document you’re not authorized to see — engframe prints the specific problem rather than a generic failure.

​
Front matter format

The file must start with a ----delimited block of front matter, followed by the Markdown content:
The content after the closing --- becomes the Document’s body.

​
Other commands