Subcommands97 subcommands
fin addon
Addons management commands: install, remove (fin help addon)
fin addon install
Install addon
fin addon remove
Remove addon
fin alias
Manage aliases that allow fin @alias execution (fin help alias). Create/update alias with <alias_name> that links to <path>
fin alias list
Show aliases list
fin alias remove
Remove alias
fin db
Manage databases (fin help db)
fin db import
Truncate the database and import from SQL dump file or stdin
fin db dump
Dump a database into an SQL dump file or stdout
fin db list
Show list of existing databases
fin db cli
Open command line interface to the DB server (and execute query if provided)
fin db create
Create a database
fin db drop
Delete a database
fin db truncate
Truncate a database (defaults to the `default`)
fin hosts
Hosts file commands: add, remove, list (fin help hosts)
fin hosts add
Add hostname to hosts file. If none provided uses VIRTUAL_HOST
fin hosts remove
Remove lines containing hostname from hosts file. If none provided uses VIRTUAL_HOST
fin hosts list
Output hosts file
fin project
Manage project(s) (fin help project)
fin project start
Start project services (alias: fin start)
fin project up
Configuration re-read and start project services (alias: fin up)
fin project stop
Stop all or specified project services (alias: fin stop)
fin project status
List project services (alias: fin ps)
fin project restart
Restart project services (alias: fin restart)
fin project reset
Recreate all or specified project services, their containers and volumes
fin project remove
Remove all project services, networks and all their volumes, or specified services only
fin project list
List running Docksal projects (alias: fin pl)
fin project create
Create a new project with a pre-configured boilerplate: Drupal, Wordpress, Magento, Laravel, Backdrop, Hugo, Gatsby, and others
fin project config
Show project configuration
fin project build
Build or rebuild services (alias for 'docker-compose build')
fin ssh-key
Manage SSH keys (fin help ssh-key)
fin ssh-key add
Add a private SSH key from $HOME/.ssh by file name. Adds all default keys (id_rsa/id_dsa/id_ecdsa/id_ed25519) if no file name is given
fin ssh-key ls
List SSH keys loaded in the docksal-ssh-agent
fin ssh-key rm
Remove all keys from the docksal-ssh-agent
fin ssh-key new
Generate a new SSH key pair
fin system
Manage Docksal state (fin help system)
fin system reset
Reset Docksal
fin system start
Start Docksal
fin system stop
Stop Docksal
fin system status
Check Docksal status
fin vm
Manage Docksal VM (fin help vm)
fin vm start
Start the machine (create if needed)
fin vm stop
Stop the machine
fin vm kill
Forcibly stop the machine
fin vm restart
Restart the machine
fin vm status
Get the status
fin vm ssh
Log into ssh or run a command via ssh
fin vm remove
Remove Docksal machine and cleanup after it
fin vm ip
Show the machine IP address
fin vm ls
List all docker machines
fin vm env
Display the commands to set up the shell for direct use of Docker client
fin vm mount
Try remounting host filesystem (NFS on macOS, SMB on Windows)
fin vm ram
Show memory size
fin vm hdd
Show disk size and usage
fin vm stats
Show CPU and network usage
fin vm regenerate-certs
Regenerate TLS certificates and restart the VM
fin bash
Open shell into service's container. Defaults to cli
fin config
Show or change configuration (fin help config)
fin config show
Display configuration for the current project
fin config env
Display only environment variables section
fin config yml
Display static YML project config suitable for export (NOTE: SECRET_* values will not be hidden)
fin config generate
Generate empty Docksal configuration for the project
fin config set
Set value(s) for the variable(s) in project ENV file
fin config remove
Remove variable(s) from project ENV file
fin config get
Get the value of the single variable from project ENV file
fin exec
Execute a command or a script in cli
fin exec-url
Download script from URL and run it on host (URL should be public)
fin init
Initialize a project (override it with your own automation, see fin help init)
fin image
Image management commands: registry, save, load (fin help image)
fin image registry
Show all Docksal images on Docker Hub
fin image save
Save docker images into a tar archive
fin image load
Load docker images from a tar archive
fin logs
Show service logs (e.g., Apache logs, MySQL logs) and Unison logs (fin help logs)
fin run-cli
Run a command in a standalone cli container in the current directory (fin help run-cli)
fin share
Create temporary public url for current project using ngrok
fin share-v2
Create a temporary public URL for the project using Cloudflare Tunnel
fin share-v2 start
Start tunnel and print public URL
fin share-v2 stop
Stop tunnel
fin share-v2 status
Prints tunnel status and public URL (if Active)
fin share-v2 url
Prints tunnel public URL
fin share-v2 logs
Prints tunnel container logs
fin vhosts
List all virtual *.docksal hosts registered in Docksal proxy
fin docker
Run Docker commands directly
fin docker-compose
Run Docker Compose commands directly
fin docker-machine
Run Docker Machine commands directly
fin composer
Run Composer commands
fin drush
Drush command (requires Drupal)
fin drupal
Drupal Console command (requires Drupal 8)
fin platform
Platform.sh's CLI (requires docksal/cli 2.3+)
fin terminus
Pantheon's Terminus (requires docksal/cli 2.1+)
fin wp
WordPress CLI command (requires WordPress)
fin cleanup
Remove all unused Docker images, unused Docksal volumes and containers
fin diagnose
Show diagnostic information for troubleshooting and bug reporting
fin sysinfo
Show system information
fin version
Print fin version. [v, -v] prints short version
