Skip to main content
GuideServerConfigure and deploy Tabsdata servers on your machine.TutorialsConfigure data integration workflows within a running Tabsdata server.Advanced TutorialsBuild end-to-end workflows between two specific systems.API ReferenceCLI ReferenceRelease Notes
Version: 2.0.0

Create a Server

After initializing a server, tdkserver create builds an instance from the config folder that tdkserver init produced.

Step 1Set the LLM API key

tdkserver create builds the aiagent pod, so the LLM key has to be in the environment before running it, not before tdkserver init:

export ANTHROPIC_KEY="sk-ant-..."
Step 2Create an instance
tdkserver create --instance myinstance

A server's name is unique and is used internally for identification. The name provided to --instance is used to find the config folder created during initialization.

Step 3Check the instance was created
tdkserver list
Output
Instances
┌──────────┬──────────────────────────────────────────────────┬──────────┬─────────┬─────────┬─────────┬─────────────────┬───────────────┬───────────────────────┐
│ Name     │ Folder                                           │ Provider │ Version │ State   │ Status  │ API Server Port │ Database Port │ API Server URL        │
├──────────┼──────────────────────────────────────────────────┼──────────┼─────────┼─────────┼─────────┼─────────────────┼───────────────┼───────────────────────┤
│ tabsdata │ ~/.tabsdata/instances/tabsdata │ kminus   │ 2.0.0   │ created │ Stopped │ 2457            │ 2460          │ http://localhost:2457 │
└──────────┴──────────────────────────────────────────────────┴──────────┴─────────┴─────────┴─────────┴─────────────────┴───────────────┴───────────────────────┘

The instance appears with its name and state. It is not running yet.

Ports​

Every service in the instance takes a port, assigned sequentially from a single base value. --port sets that base, defaulting to 2457:

tdkserver create --instance myinstance --port 3000

Two instances on one machine need base ports far enough apart that their ranges do not overlap.

What to do next​

Start a Server. The instance keeps its configuration across stops and starts, so creating it is a one-time step.

See tdkserver create for the full option list.