plasma.
Docs menu

Getting started

Command line and links.

The plasma command opens connections, files and folders in the running app, imports a file into a table, and bridges AI tools. plasma:// links do the same from a web page or a README.

Install the plasma command#

Open Settings → Advanced and find the Command line row.

  • macOS and Linux. Click Install command-line tool. Plasma asks where to put it: Install for me links plasma into ~/.local/bin, which needs no administrator rights; Install system-wide uses /usr/local/bin and may need sudo. If that folder is not on your PATH, the row says so. Plasma never overwrites an unrelated file named plasma. For an AppImage it writes a small wrapper that points at the AppImage file, and fixes the wrapper after an AppImage update.
  • Windows. The row shows instructions instead: add the folder that holds the launcher to your PATH (with setx PATH) and open a new terminal.

If the launcher cannot find the app it prints cannot find the Plasma app. Set the PLASMA_APP environment variable to the app’s executable and try again.

Commands#

CommandWhat it does
plasma open <target>Hands the target to the running Plasma, or starts it. The terminal comes back immediately.
plasma import <file> --into <url> --table <name>Opens the import dialog for a file and a table.
plasma mcpA stdio bridge to the running Plasma for AI clients that cannot make HTTP requests. See the MCP server page.
plasma --helpPrints usage.

plasma open#

The target can be one of three things, or a plasma:// link, which is handled exactly like a clicked link.

  • A connection URL (anything with ://, such as postgres://user@host:5432/db). The New connection dialog opens filled in. Plasma does not connect for you and does not save anything.
  • A SQLite file. The New connection dialog opens with the engine set to SQLite and the file chosen. A file that is not a SQLite database is reported with the reason.
  • A folder. Opens it as a team workspace (the folder should hold a .plasma/ directory).
Terminal
plasma open postgres://app@localhost:5432/shop?sslmode=verify-full
plasma open ./data/app.sqlite
plasma open ~/work/our-repo

A password inside a URL goes into the dialog’s password field only. Plasma masks it before writing the link to its log.

plasma import#

--into is a connection URL and --table is table or schema.table. The file must exist. Plasma opens the Import dialog for that file and table; you still review the preview and the column mapping and click through, exactly as if you had started from the app. See Import data.

Terminal
plasma import ./new_customers.csv --into postgres://app@localhost/shop --table public.customers

plasma:// links#

Plasma registers the plasma:// scheme. Two links exist.

LinkEffect
plasma://connect?url=<connection-url>&name=<label>&readonly=1Opens the New connection dialog filled in. name is optional (up to 80 characters). readonly accepts 1, true, yes or on and ticks the Read-only switch.
plasma://open?workspace=<absolute folder>Asks you to confirm, then opens the folder as a workspace. The path must be absolute.