softwareQ aqcess docs All tools

Command-line guide

Aqcess CLI

Run Aqcess quantum tools from your terminal. Give the CLI an OpenQASM circuit and it returns a diagram, simulation counts, or a resource report.

Visualize Simulate Estimate

Get started

Install the CLI

Aqcess runs with Bun. Once Bun is installed, run this command on macOS or Linux:

The installer does not use sudo. It places the CLI in ~/.local/bin and adds that directory to your shell path if needed.

First command

See what Aqcess can do

Confirm the installed version, then ask the server for its available apps.

01

QASM Visualizer

Turn a circuit into a diagram

Pass a QASM file and Aqcess saves a self-contained SVG beside it.

Result bell.svg

02

QASM Simulator

Sample circuit outcomes

Choose how many shots to run. Aqcess writes the measurement counts to a text file.

Result bell.simulation.txt

03

Resource Estimator

Estimate logical and physical cost

Create a JSON report for the operations and resources in the circuit.

Result bell.resources.json

Input and output

Choose where results go

Use -o to name the output, -o - to print it, and - as the input to read QASM from another command.

Aqcess will not replace an existing file unless you add --force.

Keep it current

Update or remove Aqcess

Troubleshooting

Common fixes

My shell says “aqcess: command not found.”

Open a new terminal, or run export PATH="$HOME/.local/bin:$PATH" once in the current terminal.

Aqcess will not replace my output file.

Add --force only when you intend to replace that file.

The server asks me to sign in.

The CLI has no hidden authentication bypass. It works anonymously only while the hosted showcase is in demo mode.

Can I inspect the installer first?

Yes. Download /install.sh, read it, then run the saved file with sh. The installer verifies the downloaded CLI checksum.