Skip to content

Work on a remote EDA server

If your EDA tools and licences are on a Linux server, run the Chipforge companion there and connect the desktop app to it over SSH. Your projects, tool runs, terminal and the assistant’s commands then live on the server, while you work in the app on your own computer.

  • Each engineer runs their own companion on the server, under their own account.
  • The companion listens on a Unix socket in a folder that only its own account can open, not on a network port. If AMD’s programming tools are installed on the server, the companion also starts AMD’s hw_server, which listens on TCP port 3121 on all of the server’s network interfaces.
  • The desktop app reaches the socket through an SSH tunnel. Chipforge can open and watch the tunnel for you, or you can open it yourself.
  • Work runs in the companion on the server, not in the tunnel. If the connection drops, a running synthesis carries on, and the app picks it up again when it reconnects.
  • Check that the server meets the requirements for a remote EDA server.
  • Get the companion for Linux from your Chipforge contact. It’s an archive of several programs that work together.
  • Make sure you can log in to the server with SSH from your computer.

Do this once, logged in to the server as yourself.

  1. Extract the companion archive into one folder that you can run programs from, such as ~/.local/bin. Keep all its programs together, and keep them executable. If you copy them with scp, use scp -p.

  2. Create the file ~/.config/systemd/user/chipforge-companion.service with this content:

    [Unit]
    Description=Chipforge companion agent
    [Service]
    Type=simple
    ExecStart=%h/.local/bin/companion
    Restart=on-failure
    RestartSec=2s
    [Install]
    WantedBy=default.target

    Change the ExecStart path if you extracted the companion somewhere else.

  3. Start the companion, and keep it running after you log out:

    Terminal window
    systemctl --user daemon-reload
    systemctl --user enable --now chipforge-companion
    loginctl enable-linger "$USER"

    Without enable-linger, the system stops the companion when you log out, along with any synthesis it was running. If loginctl refuses, ask an administrator to run sudo loginctl enable-linger followed by your user name.

The companion runs your EDA tools with a fixed set of environment variables, not with your login profile. If your tools rely on variables from your profile, such as their location or a licence server, set them in Settings → Local Toolchains after you connect. See Toolchains and simulators.

This is the recommended way. Chipforge runs your system’s ssh command, so your own SSH configuration applies, including Host aliases, ProxyJump and your SSH agent.

Chipforge can’t type a password or answer a prompt. Before you start, check that this command finishes without asking you anything:

Terminal window
ssh -o BatchMode=yes you@eda-server true

If it asks to confirm the server’s host key, run ssh you@eda-server once and accept it.

  1. In Chipforge, select Settings in the sidebar, then select Connection.

  2. Select Let Chipforge open the tunnel.

  3. In SSH host, enter what you’d type after ssh, such as you@eda-server or a Host alias from your ~/.ssh/config.

  4. Select Detect. Chipforge logs in to the server, finds your companion’s socket, and fills in Remote companion socket.

  5. Select Save, then quit and reopen Chipforge.

From then on, Chipforge opens the tunnel when it starts, and reconnects on its own if the connection drops.

Use this if your server needs a password or a one-time code.

  1. Find your companion’s socket on the server:

    Terminal window
    ssh you@eda-server "echo Zm9yIGIgaW4gIiR7WERHX1JVTlRJTUVfRElSOi0vcnVuL3VzZXIvJChpZCAtdSl9IiAiJHtYREdfQ09ORklHX0hPTUU6LSRIT01FLy5jb25maWd9IiAiJHtUTVBESVI6LS90bXB9IjsgZG8KICBmb3IgcCBpbiAiJGIiL2NoaXBmb3JnZS9ydW4vKi9jb21wYW5pb24uc29jazsgZG8KICAgIFsgLVMgIiRwIiBdICYmIHsgcHJpbnRmICVzICIkcCI7IGV4aXQgMDsgfQogIGRvbmUKZG9uZQpleGl0IDE= | base64 -d | sh"

    It prints the socket’s path. This is the same check that Detect runs, encoded so that it works whatever your login shell is. Decoded, it reads:

    Terminal window
    for b in "${XDG_RUNTIME_DIR:-/run/user/$(id -u)}" "${XDG_CONFIG_HOME:-$HOME/.config}" "${TMPDIR:-/tmp}"; do
    for p in "$b"/chipforge/run/*/companion.sock; do
    [ -S "$p" ] && { printf %s "$p"; exit 0; }
    done
    done
    exit 1

    Copy the path it prints. Don’t build the path yourself from your user name: the folder name isn’t always your user name as you type it.

  2. Forward a local port to the socket, and leave the command running:

    Terminal window
    ssh -N -L 4830:/run/user/1001/chipforge/run/chipforge-you/companion.sock you@eda-server

    Replace the path with the one from step 1. Any free local port works; 4830 is the usual one. If your network drops idle connections, add -o ServerAliveInterval=30.

  3. In Chipforge, select Settings → Connection, then select I’ll open the tunnel myself.

  4. In Companion URL, enter http://127.0.0.1:4830.

  5. Leave This companion is on another machine ticked, so that Chipforge uses the server’s files and terminal rather than your computer’s.

  6. Select Save, then quit and reopen Chipforge.

In Settings → Connection, select Use the companion bundled with this app, select Save, and reopen Chipforge. If Chipforge asks Forget the saved SSH tunnel?, select Discard it.

Move files between your computer and the server

Section titled “Move files between your computer and the server”

When your project is on the server, the Explorer in the project offers file transfer instead of Show in folder.

  • Upload: select the upload button at the top of the Explorer, or right-click a folder and select Upload Files…. You can also drag files or folders from your desktop onto the file tree.
  • Download: right-click a file and select Download, then choose where to save it. You can download single files, not folders.

Transfers go through the same SSH tunnel as everything else. They’re safe on an unreliable connection: an interrupted upload or download leaves no partial file behind. Chipforge never overwrites a file without asking: it offers Replace or Skip existing.

New names follow the same rule as everywhere in Chipforge: A–Z, a–z, digits, ., _ and - only. A file such as top (1).sv isn’t uploaded, and Chipforge tells you what to change. Rename it on your computer and upload it again.

What you see What to check
The Companion status stays on Connecting… The tunnel is down, or your companion isn’t running on the server. On the server, run systemctl --user status chipforge-companion.
Detect says it “found no Chipforge companion running as that user” SSH works, but your companion isn’t running on the server. Start it, then select Detect again.
An SSH message such as “Permission denied (publickey).” Key login doesn’t work without a prompt. Run ssh -o BatchMode=yes you@eda-server true in a terminal and fix what it reports.
The upload button is unavailable The companion on the server is too old to accept uploads. Update it.
Dropping files on the window does nothing Drop them on the file tree in the Explorer.
The companion won’t start and mentions a lock Another companion is already running under your account on that server.

See also Troubleshooting.