Heicode Docs

Quickstart

Quickstart

This page describes the shortest path to launching an Agent task in Heicode. You don't need to configure a model provider in advance, and you don't need to touch the secret vault backend.

Before you start

  • A Heicode account.
  • The Heicode client installed, or available for download.
  • A goal you want to accomplish, such as fixing a bug, building a feature, generating documentation, or deploying a project.
  • If the task involves code, a Git repository ready to go.
  • If the task involves deployment, a cloud account or authorizable cloud resources ready to go.

Step 1: Sign in to Heicode

  1. Open Heicode Manager.
  2. Sign in with your account.
  3. Confirm that the home page shows tasks, resources, model usage, and the client download entry point.31f865c364999514ec5299004425768c.png

Step 2: Bind resources

Click Resource Binding on the left. A Git resource is the foundation — both Sub mode and Swarm mode require a Git resource binding before they can be used. Common resources include:

  • Git repositories.
  • Product documentation.
  • SK skill libraries.
  • Cloud accounts.
  • Cloud resources, such as databases, static sites, Kubernetes, and object storage. 2a669e9121f0e93b8d4cd8b139fc6de0.png After connecting a resource, Heicode shows its masked status and scope. Long-lived secrets go into the secret vault, and the page only shows the reference and its status.

Step 3: Deploy a Sub Agent

Click Deploy Sub Agent on the left side of the page. You can choose a single Agent or a developer team; once deployed, the deployed Agent is shown in sync at the bottom of the page (by default, up to 5 Agents can be installed — the exact number depends on your plan).8e97aca64a191270b2569c4e3584d388.png4cbf20e9f399e8e0a1b2502d9c3da294.pngSwapping or deleting an already-deployed Agent is also done here.595d9d915c1e665d3fe3ad82e0f46ba5.png

Step 4: Download and install the Heicode client

Click Heicode Desktop Client on the left side of the page, download the client for your system, and open it.87ca1f402d1c30dc21b096fccfa3a4dc.png

Step 5: Call the deployed Sub Agent

Sign in from the client. Click Agents on the client's home page — you'll see and can select the Agent you just deployed in Heicode Manager. Check it to start using it.4e61204890ef30f44bf432a88758f49c.png

The user mainly enters tasks and handles approvals in the client. Manager is used for preparing resources, launching Agents, and viewing status, usage, and audit logs.

Step 6: Enter a goal

Enter what you want to accomplish in the client.

Recommended format:

What I want to do:
Existing code or documentation:
Where I want to deploy:
What must be confirmed with me first:
Acceptance criteria:

Example:

I want to add a resource center page to our existing website.
We already have material in docs/product-package.
The resource center should be written as an in-site document, not a link out to Git.
Deploy to Azure Static Web Apps once the build passes.
I need to confirm before deployment.

After submitting the goal, the Agent starts executing. You can view the progress in the task view.

Step 7: Watch the task status

Once the task launches, you'll see the task view.

There are nine top-level task states:

StatusMeaningWhat you should do
createdTask created, not yet started preparingWait
preparingPlatform is organizing resources and contextWait
runningAgent is executing the taskMonitor progress
waiting_approvalA pending approval request existsReview risk and approve or reject
degradedSome capabilities unavailable, task continues in limited modeMonitor the degradation reason
verifyingAgent is verifying deliverablesWait for verification to complete
completedTask completed successfullyReview deliverables
failedTask stopped due to an errorCheck failure reason and retry or adjust resources
stoppedTask stopped by you or the platformReview results, restart or duplicate the task

The following prompts may also appear in the task view, corresponding to specific signals under the running state:

  • Needs input: The Agent needs you to provide additional information, resources, or permissions — open the task and reply.
  • Awaiting approval: A pending approval request exists (the approval request itself has its own states: pending / approved / rejected / expired) — review the risk and approve or reject.
  • Ready to review: The task is still running, but has already produced deliverables you can inspect ahead of time.

Step 9: Handle items that need your attention

The Agent may need you in these situations:

  • The requirements aren't clear.
  • A resource isn't connected.
  • Permissions are insufficient.
  • The budget is insufficient.
  • Production deployment is needed.
  • Access to production secrets is needed.
  • Confirmation of the implementation direction is needed. 761778426bec6c7808f2fc35593e82c2.png

In the task view, you can reply, approve, reject, or stop the task.

Step 10: Review the results

Once the task is done, check:

  • Deliverables.
  • Code diff.
  • Test results.
  • Build results.
  • Deployment results.
  • Model usage.
  • Approval records.
  • Audit records. ffb31c1ec3f1008c1097730aed75b3f7.png If the result is incomplete, you can continue adding requirements in the client, so the Agent moves into the next iteration.

Last updated on

On this page