---
title: TouchUp documentation
---

# TouchUp documentation

## Get started

- [What is TouchUp](/touchup/documentation/overview) : The robot workbench for VS Code: what it does with a Fanuc or Yaskawa controller, its parts, and the rules it follows: no cloud, no project, free to read, explicit writes.
- [Install TouchUp](/touchup/documentation/install) : The files of a release: the VS Code extension, the Windows setup and MSI, the Linux AppImage and the portable packages, and how to start the web application on your PC or for the PCs of your network, over HTTPS, and why TouchUp opens only folders of the computer that runs it. Nothing else to install.
- [Connect to your first controller](/touchup/documentation/first-connection) : Add a Fanuc or Yaskawa controller with the guide: brand, address, protocols and passwords, the test in plain words, which protocol does what, what TouchUp learned about the robot and the Hello TouchUp! check. Connect, edit in the guide, choose a robot.ini, order the controllers.
- [Controllers and configuration files](/touchup/documentation/configuration) : The global file and the .touchup folders, which one wins, the passwords in the OS keychain, and a list of controllers shared as a CSV file.
- [Editions and license](/touchup/documentation/license) : Free to read, paid to write: what the free edition does, what needs a Pro subscription, the Account page with the email code, the free trial of 24 hours, the license file of an offline PC, Sign out of this PC, the 5 PCs of a subscription, the diff that a free user sees before a save is refused, the Feedback page with Report this error and the optional share of your configuration, and the grace period.
- [Buy TouchUp Pro and change its brands](/touchup/documentation/buy-pro) : Buy Pro per brand on the purchase page: the prices, the billing period, the VAT by country, the payment by card or by quote, the license after the payment. Then add a brand at once, remove a brand at the end of the paid period, cancel and resume on your account page.

## Controllers

- [Prepare a Fanuc controller](/touchup/documentation/fanuc-setup) : The network, the ports, the FTP user, the SNPX option and the ROBOGUIDE workcell that TouchUp needs to connect to a Fanuc controller.
- [Prepare a Yaskawa controller](/touchup/documentation/yaskawa-setup) : The Ethernet function, the UDP ports, the RS parameters and the remote settings that TouchUp needs to connect to a YRC1000, DX200 or older Yaskawa controller.
- [When the connection fails](/touchup/documentation/connection-failure) : The lost state of a controller, the test of the guide in plain words, Test Connection, and the connection report: the checks, the probable causes with their steps and the conditions to verify.

## Monitor

- [Status and status bar](/touchup/documentation/status) : The active controller in the status bar, the Status view (program and line, mode, execution, servo, speed override and alarms, live) and the Identify button that shows Hello TouchUp! on the controller.
- [Alarms and logs](/touchup/documentation/alarms) : Notifications of the alarms, the active alarms, the continuous alarm log beyond the history of the controller, its filters and its CSV export.
- [Read live values](/touchup/documentation/live-values) : The Registers, Variables, I/O, Tasks and Watch views, the completion, the CSV export and import and the reorder of the Watch list, and the values on the programs you edit: comment, current value, inline hints and the line the controller executes, on Fanuc and Yaskawa.
- [Data and I/O panels](/touchup/documentation/data-panels) : The Data panel and the I/O panel of a Fanuc or Yaskawa controller: open them from the tree, choose the kind and the page of 50, edit several cells, then write them with one confirmation. Pending changes, Revert, the Pro edition, the cells that are read-only, Add to Watch, and Simulate and Unsimulate of a Fanuc signal.
- [Follow a program with the debugger](/touchup/documentation/debug-a-program) : Attach Debugger on a task of a controller: the task shown running or paused, the program opened at its line, the registers, variables and I/O of the frame, breakpoints in the gutter, Continue, Step and Pause with their confirmations, the limits of a Fanuc controller, the warning when the file differs from the controller, the launch configuration, and what Yaskawa gives: the stack, the step and the running job, read only.
- [Robot 3D](/touchup/documentation/robot-3d) : The Robot 3D tab: a simple 3D drawing of the robot of the active controller at its live pose, grey when the pose is older than 2 seconds, the kinematic data of the robot kept with its source and date, Refresh Kinematic Data, and the reasons shown in place of the robot (CRX arm, FTP off, Yaskawa group above 1).
- [Inventory](/touchup/documentation/inventory) : Every controller seen by TouchUp, with its model, serial number, software version and connections, exported to CSV.

## Write and control

- [Write values and control a program](/touchup/documentation/write-and-control) : Write a register, a variable or a signal with a confirmation and a report, change values in the Watch view and write them together, run a program from a line, hold, continue and abort, reset the alarms, and what the Fanuc and Yaskawa controllers refuse.

## Files, backup and compare

- [Open controller files](/touchup/documentation/controller-files) : The nodes of a Fanuc or Yaskawa controller in the Controllers view (3D & Status, programs, data, I/O, Tasks, parameters), Reveal in Files and Reveal in the node, New Program, the Files node, a Fanuc TP program opened through its listing or printtp, the colors of each file type, the save of a file back to the controller and the dialog when the file changed.
- [KCL Terminal](/touchup/documentation/kcl-terminal) : Type KCL commands (SHOW, SET VAR, RUN, ABORT, RESET) in a terminal of VS Code and read the answer of a Fanuc controller: how to open it under Command Files, the Pro edition, the confirmation once per connection, safe and unsafe mode, /clear, the history, what is recorded in the audit log and what the terminal does not do.
- [Manage controller files](/touchup/documentation/manage-controller-files) : Create, import, rename, delete, copy and move the files of a controller like in the Explorer: buttons and menu of the Files node, one confirmation per gesture with a copy of every replaced or deleted file, Cut, Copy, Paste and drag and drop between controllers and your PC, Replace or Keep Both, and what Fanuc and Yaskawa cannot do.
- [Send a file to the controller](/touchup/documentation/send-to-controller) : Send a program or a file of your PC to a controller, with the steps of every write: license, confirmation, copy of the old file and audit log. A Fanuc program without ASCII Upload: the changed lines or maketp.
- [Back up a controller](/touchup/documentation/backup) : One click backup of a Fanuc or Yaskawa controller into the folder of your choice or of your workspace, one subfolder per backup, with the changes since the last one, the three file lists of a controller, the restore of one file, the copy of files to another robot of the same brand with the robot-specific files left out, the commit to Git and the mastering values of a Fanuc robot.
- [Compare backups and controllers](/touchup/documentation/compare) : Compare two backups, a controller or one of its files with the last backup, two files of your PC, a file of your PC with the controller, or a backup folder of a disk, with a change summary, the noise of each brand removed, and the parameters as a table with the old value struck through.
- [Robot report and handover pack](/touchup/documentation/report-and-handover) : The robot report as a Markdown file and a PDF, made offline from the backups, the inventory and the alarm log of your PC, and the handover pack: one zip with the newest backup and the report of each robot, what the import checks and refuses.
- [The format of a backup](/touchup/documentation/backup-format) : The folder of a backup, every field of touchup-backup.json, the hashes, the profile, the files that the controller refused, the JSON schema, a Python script that reads and checks a backup without TouchUp, and the rules of versioning.

## Edit programs and data

- [Edit a program](/touchup/documentation/edit-a-program) : Problems found while you type, the outline, folding, hover, completion and signature help from the instruction catalogs, live values of the controller on the program, examples in the hover, go to definition, line numbers kept while you type, Add Position and Update with Current Position, Open, Copy and Paste Position at the cursor, the Format button and Format Document for TP and INFORM, the colors, and the Shift JIS encoding of Japanese files.
- [Edit Karel and KCL files](/touchup/documentation/karel-and-kcl) : The Karel sources, the KCL files and the command files of a Fanuc controller: problems, outline, folding, go to definition, hover and completion, what the first version of the rules checks, KCL inside a Karel program, Compile with ktrans, the source of a Karel program opened from the Karel Programs node and how to change it, and Run in KCL Terminal on a KCL file, a command file or a KCL call of a Karel source.
- [Edit a position](/touchup/documentation/position-editor) : Open a position register or the position of a program, read it in its stored form and the other form computed, edit the values and the Fanuc configuration, Apply with a confirmation, Copy as TP or JBI and Paste as a pending value, the Position view that edits a position in the text of a program with the controller that computes its other form and Set to current position, the robot in 3D with the edited target and the position as read, Compare with the current position or another one, and the Yaskawa limits.
- [User frames and tools](/touchup/documentation/user-frames-and-tools) : The User Frames and Tools view of a Fanuc controller or backup: the tables with the active ones and the payload schedules, the pending value and its difference with the controller, why Apply is not available yet, the compare of two backups and the AI tools.
- [Toolbox](/touchup/documentation/toolbox) : The instructions of the TP or INFORM language by category, a search, an insert at the cursor, on the right line, with its tab stops, and your own catalog laid over the shipped one.
- [Navigate across a robot](/touchup/documentation/navigate-a-robot) : Go to definition, find references and workspace symbols across the programs of a robot, the index of every controller made in the background, Index This Robot, the warning for a program that is not there, and the Variable Map with the free and used indexes.
- [Parameter and variable files](/touchup/documentation/parameter-and-variable-files) : The table of a Yaskawa .prm file and the tree of a Fanuc .va listing, opened by default with Reopen Editor With for the text, ALL.PRM read-only, and the tables of VAR.DAT by type with their names and uses.

## AI assistants

- [AI chat of the desktop and web applications](/touchup/documentation/ai-chat) : Ask a question about your robots in the AI chat panel of the desktop and web applications: nothing leaves your PC before you set up a provider and send a message, the providers (Claude account, Copilot, API keys, Ollama), the TouchUp tools that you pick in the chat and allow one by one, the note on keys in the web application, the switches to turn the AI off and the untrusted workspace.
- [AI tools and MCP server](/touchup/documentation/ai-tools) : Let Copilot Chat, Claude Code or another MCP host read your robots and learn the TP and INFORM languages: the read-only tools, the guides and the validator of a program, Copy MCP Server Configuration, the setting to turn it off and the machine policy.
