Talisman Studio for VS Code
Talisman Platform's Local Development Kit for Visual Studio Code. Design, run and debug Apache Camel integration
projects on your machine, in your own git repository, with the same designers and runtime as Talisman Platform, then
deliver them to the platform through a pull request.
Talisman Studio is part of a Talisman Platform subscription. A 30-day trial starts
on first use, without sign-up.
Features
Design
- Project topology: every route, REST endpoint, OpenAPI operation, Kafka topic and outgoing endpoint of a project in
one diagram, with its beans, variables, JSON schemas and Groovy scripts in a side panel.
- Camel designer: build routes visually from the full Apache Camel catalog: components, EIPs, kamelets, beans,
error handlers and route configurations. Opens on any
*.camel.yaml and *.kamelet.yaml.
- OpenAPI and JSON Schema designers for
openapi.json and *.schema.json, including schemas shared across projects.
- Command palette (+ in the designer) to find and add a step.
- The designers write plain YAML and JSON to your project; edit in the designer or the text editor, side by side.
AI assistant
- Bring your own AI: your Anthropic, Google Gemini or OpenAI key, kept in VS Code's secret storage; the assistant
runs locally in Docker (opencode), nothing to install.
- One button, the ✦ in the editor toolbar: the Talisman AI panel opens beside your editors; the file or project
you look at is the context of what you ask. A coding agent's chat, terminal-style: the integration engineer plans the
change, writes the files, validates them, runs and inspects the project, and fixes it - every step on its own line,
the changed files with their diffs - and you continue with follow-ups.
/route, /groovy, /sql… insert a task
template.
- Built on Talisman's best practices (skills), Apache Camel's catalog and examples, and Camel's CLI.
Run and observe
- Run a project locally on Docker, or in a local Kubernetes cluster (k3d or minikube), on the Talisman
devmode image, the same image Talisman Platform uses in development.
- Reload changes into the running project without restarting it, and follow its log in a terminal.
- Camel Runtime panel: the context, routes and their statistics, HTTP endpoints, errors with the exchange that
failed (one click opens the failed step in the designer), traces and JVM memory and threads.
- Live topology: route states and statistics on the diagram; suspend, resume, stop and start a route.
- TryOut API: an interactive API reference of the project's OpenAPI document, calling the running project.
- Dev services: start Kafka, PostgreSQL, ActiveMQ Artemis and other services your projects need, defined in the
repository.
Build and deliver
- Build Image: build a project's image and push it to your registry the way the Talisman server builds - the
repository's
configuration/build.sh (yours to customise) clones the pushed branch from origin, where the project
runs in dev mode; a Kubernetes repository's project gets its kubernetes.yaml back, to commit. Offered once
talisman-studio.build.registry is set; the password with Talisman: Set Registry Password. The clone uses your
SSH key (an ssh remote) or talisman-studio.build.git.username and Talisman: Set Git Token (an https remote).
- Export Project as Zip: send a project as
<projectId>.zip, the format Talisman Platform's Upload Project
imports. Pick the files; the ones git ignores (.env) start unticked, values that look like secrets are pointed out,
and a .env.example with the keys only can go in instead of .env.
- Add CI/CD Pipeline: GitHub Actions or Azure Pipelines for the repository - a template in
templates/, one
pipeline per project (written with Create Project, Generate Pipeline on a project, deleted with Delete Project)
that builds and pushes the image, commits kubernetes.yaml and applies it with kubectl. The template's first lines
list the variables and secrets to create. The Pipelines view lists the repository's pipeline files, with
Regenerate Pipeline on a project's.
Edit with assistance
application.properties: completion of Camel, Camel JBang, Jib, JKube and component options with their
descriptions and defaults; warnings for unknown, renamed and removed Camel options, with quick fixes.
- Groovy: completion of the Exchange and CamelContext APIs, the headers, properties and variables your routes set,
and generated code for your OpenAPI and JSON schemas.
Work in git
- Your projects live in your own repository and branches; Studio for VS Code never needs the platform to design or run them.
- Templates and Configuration views mark what differs from the base branch (
main), so platform files stay in step.
- Several Talisman repositories in one workspace: switch between them in the Repositories view.
Requirements
- Visual Studio Code 1.106 or later, and git.
- For Docker repositories: Docker with Compose v2 (Docker Desktop, OrbStack, Colima or Docker Engine).
- For Kubernetes repositories:
kubectl and a local cluster - k3d or
minikube (with minikube addons enable registry).
- Internet access to pull the Talisman devmode and service images from Docker Hub.
- macOS, Windows or Linux.
Getting started
- Just start: the 30-day trial begins on first use. For Developer Seats, install the license file your company
received: Talisman: Install License File (or the button in the Talisman view).
- Open the folder of a Talisman repository, or an empty folder and run Talisman: Initialize Talisman Repository
(choose Docker or Kubernetes).
- Open the Talisman view in the activity bar and create a project with Create Project.
- Click the project to open its topology; add routes from the toolbar or the command palette.
- Run the project from its tab or the Projects view; open Camel Runtime in the bottom panel to watch it.
- Commit to a feature branch and open a pull request to deliver the project to Talisman Platform.
Settings
| Setting |
Default |
What it does |
talisman-studio.devmodeImage |
Studio for VS Code's version |
The devmode image a project runs on. |
talisman-studio.platformHost |
automatic |
The address containers and Pods reach this machine by (rootless Docker, minikube with a VM driver). |
talisman-studio.build.registry |
empty |
The registry Build Image pushes to - reachable from the build container, e.g. talisman-registry:5000 or host.docker.internal:5000, not localhost. Empty: no Build. |
talisman-studio.build.group, platform, username |
talisman, linux/amd64, empty |
The image's group, platform(s) and the registry user (its password in VS Code's secret storage). |
talisman-studio.build.git.username |
empty |
The git user Build clones an https remote with (its token: Talisman: Set Git Token). |
talisman-studio.build.git.privateKeyPath, knownHostsPath |
~/.ssh/id_ed25519 (else id_rsa), ~/.ssh/known_hosts |
The SSH key and known hosts Build clones an ssh remote with (no passphrase). |
talisman-studio.kubernetesNamespace |
talisman |
The Talisman namespace offered when a Kubernetes repository opens. |
talisman-studio.environments |
dev, test, prod |
The platform's environments; <env>. files are left out of local runs. |
talisman-studio.platform.managementPort, apiPort |
9876, 9080 |
The local ports through which Studio for VS Code reaches running projects. |
talisman-studio.platform.nginxImage, reposiliteImage |
pinned versions |
The images of Studio for VS Code's local services. |
talisman-studio.baseBranch, compareWithBaseBranch |
main, on |
The branch platform files are compared with. |
Licensing & privacy
- Trial: 30 days from first use on a device, no sign-up, no email, no server. The start date is signed and kept on your
machine only: in the operating system's keychain, in VS Code's storage and in the visible file
~/.talisman/trial
(C:\Users\<name>\.talisman\trial on Windows). It does not run in remote windows (Remote-SSH, WSL, dev containers, Codespaces).
When it is over, install a license file or talk to sales.
- Enterprise: a license file for each Developer Seat (Talisman: Install License File), checked on your machine only.
- Nothing is sent for licensing, and Talisman Studio sends no telemetry. It works with your local Docker or Kubernetes
cluster, your git repository and your running projects, and pulls container images from Docker Hub.
License
Talisman Studio is proprietary software licensed under the
Talisman Platform License, included in the extension's
LICENSE file. It includes open-source components, among them parts derived from
Apache Camel Karavan, licensed under their own licences: see the NOTICE,
THIRD-PARTY-NOTICES.txt and LICENSES files included in the extension.
Apache, Apache Camel and the Apache Camel logo are trademarks of The Apache Software Foundation.
Support
Documentation: docs.talismanplatform.com.
Subscription customers receive support as described in the Talisman support policy.
| |