Skip to main content

Quick Start

Applies to SDK 0.16+ · Last updated: 2026-06-12

Install the SDK, run setup, pick an LLM provider, and run your first agent skill — usually in under ten minutes. Ollama works without an API key. Security stays fail-closed by default: untrusted community code runs sandboxed or not at all, and your credentials never leave your machine.

Before you start

  • Python 3.10+ and pip.
  • (Optional) Docker or Podman — needed only to run untrusted community packages, which execute in a sandbox. Trusted and curated packages run without it.
  • (Optional) Ollama — for a local provider path that needs no hosted API key.

Install AgentNode

One command installs the SDK and the agentnode CLI. No account is needed to search, install, or run packages — only publishing requires one.

terminal
$ pip install agentnode-sdk

Run setup

The setup wizard is interactive and covers every first-class setting as a multiple-choice prompt with a marked (recommended) default: installation behavior, minimum trust level, permissions, guard posture, LLM credentials, the sandbox, and the host-trust policy — plus an optional advanced gate. Accepting every recommendation reproduces today's default config; you can also skip entirely. In a non-interactive shell (CI) every prompt takes its recommended default and never blocks automation.

terminal
$ agentnode setup

Check your configuration

Confirm which providers are configured and whether the sandbox is ready. Both commands only report — they change nothing.

terminal
$ agentnode auth status     # configured LLM providers (incl. Ollama) + connectors
$ agentnode sandbox doctor  # is the sandbox ready, and why a package is blocked

Run your first capability

Search the registry, install a pack, and run one of its tools — all from the CLI.

terminal
$ agentnode search "pdf extraction"
$ agentnode install pdf-reader-pack
$ agentnode run pdf-reader-pack --input '{"file_path":"report.pdf"}'

Or call it from Python. run_tool() runs in an isolated subprocess by default.

agent.pypython
from agentnode_sdk import run_tool

result = run_tool("pdf-reader-pack", file_path="report.pdf")
print(result.result)

No API key? Use Ollama

Ollama is a local, keyless provider. Select it as your default, then check that your local Ollama is reachable.

terminal
$ agentnode config set llm.default_provider ollama
$ agentnode auth test ollama   # checks your local Ollama is reachable

This path needs no hosted API key, but it is not zero-setup: you must install Ollama, have it running, and pull a model. AgentNode never starts Ollama for you — auth test ollama is only a localhost reachability check.

Safe by default

  • Untrusted community code (verified / unverified) runs in a hardened container or not at all — there is no silent fallback to host execution.
  • Trusted and curated packages run host-side under policy checks.
  • Credentials stay in your OS keychain and never enter sandboxed code.

Details: Execution sandbox and the security model.

Troubleshooting

SymptomFix
agentnode: command not foundActivate the Python environment where you installed it (or reinstall: pip install agentnode-sdk).
No provider configuredRun agentnode auth status, then agentnode auth set <provider> — or switch to the keyless Ollama path.
Ollama not runningStart Ollama and pull a model, then verify with agentnode auth test ollama.
Sandbox unavailableRun agentnode sandbox doctor; install Docker or Podman and run agentnode sandbox pull. See /docs/sandbox.
Authentication / key missingStore the key with agentnode auth set <provider>, then confirm with agentnode auth test <provider>.

Related