s6: the s6-instance-list program
Keywords: s6 command s6-instance-list instance dynamic instantiation instanced services list listing

s6
Software
skarnet.org

# The s6-instance-list program

s6-instance-list gives a list of all currently created instances of an instanced service.

## Interface

         s6-instance-list servicedir

- s6-instance-list expects a running, supervised instanced service in servicedir, as well as an existing instance of this service named name.
- It prints to stdout, one per line, the names of all existing instances of servicedir, i.e. the ones that have been created and not deleted. It does not matter if the instances are up or down; if they've been created and not deleted, they're printed.
- It exits 0.

## Exit codes

- 0: success
- 100: wrong usage
- 111: system call failed

## Notes

- The list is unsorted, the instance names are printed in an unspecified order.
- You can use s6-instance-list to script commands that handle sets of instances. For example, to get the status of all the instances of a given service, you could write: `for i in `s6-instance-list service` ; do printf "%s: " $i ; s6-instance-status service $i ; done`