Documentation

$ particle run myapp --size p2
Creating particle 'myapp' (p2: 2 vCPUs, 4GB RAM, 20GB disk)...
✓ Particle 'myapp' is running

$ particle list
NAME      SIZE   STATUS    URL
myapp     p2     running   myapp.runparticle.com
staging   p1     stopped   staging.runparticle.com

$ particle status myapp
Name:     myapp
Size:     p2 (2 vCPUs, 4GB RAM, 20GB disk)
Status:   running
Uptime:   3h 42m
Idle:     sleep
URL:      myapp.runparticle.com

$ particle stop myapp
✓ Particle 'myapp' stopped

$ particle start myapp
✓ Particle 'myapp' is running

$ particle delete myapp
Deleted particle myapp

$ particle rename myapp production
✓ Renamed 'myapp' → 'production'

$ particle resize myapp p4
Resized myapp to p4

$ particle duplicate myapp myapp-copy
Cloning 'myapp' → 'myapp-copy'...
✓ Particle 'myapp-copy' created (stopped)

$ particle rebuild myapp -y
Rebuilt particle myapp

$ particle images
NAME            DESCRIPTION               DEFAULT
ubuntu-24.04    Ubuntu 24.04 LTS          *
debian-12       Debian 12 (Bookworm)

$ particle ssh myapp
Welcome to Ubuntu 24.04 LTS
root@myapp:~# 

$ particle exec myapp -- uptime
 14:32:01 up 3:42, 0 users, load average: 0.00, 0.00, 0.00

$ particle cp ./app.tar.gz myapp:/tmp/
app.tar.gz                  100%  4.2MB  12.1MB/s   00:00
$ particle cp myapp:/var/log/app.log ./
app.log                     100%  128KB   8.5MB/s   00:00

$ particle forward myapp 5432 8080
Forwarding 127.0.0.1:5432 → myapp:5432
Forwarding 127.0.0.1:8080 → myapp:8080
Press Ctrl+C to stop

$ particle ssh-config --write
  ✓ myapp.particle
Written to ~/.ssh/config

$ particle open myapp
Opening https://myapp-a1b2c3d4.runparticle.com ...

$ particle logs myapp -f
[    0.000000] Linux version 6.1.0 ...
[    2.345678] systemd[1]: Started OpenSSH server.
█ streaming...

$ particle port myapp 3000
Set HTTP port for myapp to 3000

$ particle idle myapp on
✓ Idle policy for 'myapp' set to: on (always running)

$ particle env set myapp DATABASE_URL=postgres://localhost/mydb
Set DATABASE_URL
Restart the particle for changes to take effect.
$ particle env list myapp
DATABASE_URL  postgres://localhost/mydb
$ particle env rm myapp DATABASE_URL
Removed DATABASE_URL

$ particle domain set myapp app.example.com
✓ Custom domain set: app.example.com → myapp
$ particle domain clear myapp
✓ Custom domain removed from 'myapp'

$ particle snapshot create myapp before-deploy
✓ Snapshot 'before-deploy' created

$ particle snapshot list myapp
NAME              SIZE      CREATED
before-deploy     2.1 GB    2026-03-07 10:30
initial-setup     1.8 GB    2026-03-05 14:00

$ particle snapshot restore myapp before-deploy
✓ Snapshot 'before-deploy' restored

$ particle snapshot delete myapp before-deploy
✓ Snapshot 'before-deploy' deleted

$ particle account
Account:    SHA256:a1b2c3...
Balance:    $9.76
Particles:  1 running, 1 stopped
Burn rate:  $0.024/hr

$ particle account email you@example.com
✓ Recovery email set
$ particle account rotate-key
New API key: rp_k1_n3w4k5e6y7...

$ particle topup 25
Opening Stripe checkout...
✓ $25.00 added to your account

$ particle usage
PARTICLE     SIZE   STATUS     COMPUTE    TOTAL
myapp        p2     running       48.2h   $1.16
staging      p1     stopped       12.0h   $0.14
──────────────────────────────────────────────────
                                          $1.30

$ particle history
DATE         TYPE      AMOUNT    BALANCE
2026-03-06   topup     +$25.00   $25.00
2026-03-06   usage     -$0.24    $24.76

$ particle key list
FINGERPRINT                    ADDED
SHA256:a1b2c3d4e5f6...         2026-03-01
$ particle key add ~/.ssh/id_ed25519.pub
✓ Key added: SHA256:x7y8z9...
$ particle key remove SHA256:x7y8z9
✓ Key removed

$ particle login
Enter your recovery email: user@example.com
Check your email for a verification link...
✓ Logged in. API key stored in ~/.config/particle/credentials

$ particle upgrade
Downloading particle v0.3.0...
✓ Updated to v0.3.0

# Bash
$ particle completion bash > /etc/bash_completion.d/particle

# Zsh
$ particle completion zsh > "${fpath[1]}/_particle"

# Fish
$ particle completion fish > ~/.config/fish/completions/particle.fish