Get started

Push / Pull

Copy page

Push and pull your agents to and from the Visual Builder

Push code to visual

One of the key advantages of Inkeep is its code-to-visual workflow. You can define your agents in code, push them to the Visual Builder, and continue developing with the intuitive drag-and-drop interface.

We'll walk through the process of pushing your code to the Visual Builder in 5 easy steps.

Step 1: Install the Inkeep CLI

pnpm install -g @inkeep/agents-cli

Step 2: Download a template project

Navigate to the src/projects directory.

cd src/projects

Add the docs assistant agent using inkeep add.

inkeep add docs-assistant

Find the downloaded code in src/projects/docs-assistant.

Note
Note

inkeep add imports a template project from our cookbook library into your src/projects directory.

Step 3: Push code to visual

Navigate to your docs assistant project.

cd src/projects/docs-assistant

Use inkeep push to push the code to the Visual Builder.

inkeep push

Step 5: Chat with your agent

Refresh http://localhost:3000, switch to the Docs Assistant project, navigate to the Docs Assistant agent, click Try it, and ask a question about Inkeep.

Chat with your agent

Pull code from visual

You can also pull code from the Visual Builder to your local project using inkeep pull.

inkeep pull

Step 1: Make an edit visually

Make an edit to the docs assistant agent in the UI, such as changing the prompt of the agent.

Step 2: Pull code from visual

Navigate to your docs assistant project.

cd src/projects/docs-assistant

Use inkeep pull to pull the code from the Visual Builder to your local project.

inkeep pull

Step 3: Verify the code was pulled

Check the src/projects/docs-assistant/agents/docs-assistant.ts file for the updated prompt.

cat src/projects/docs-assistant/agents/docs-assistant.ts

Next steps

Next, we recommend setting up observability to see live traces of your agent. See Traces to get started.