---
name: "vinyladm"
section: "1"
platform: "linux"
package: "vinyl-cache"
version: "9.1.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/vinyladm"
---

# vinyladm(1)

Control a running Vinyl Cache instance

## NAME

vinyladm - Control a running Vinyl Cache instance

## SYNOPSIS

vinyladm \[-h\] \[-n workdir\] \[-p\] \[-S secretfile\] \[-T \[address\]:port\] \[-t timeout\] \[command \[...\]\]

## DESCRIPTION

The *vinyladm* utility establishes a CLI connection to **vinyld** either using -n *workdir* or using the -T and -S arguments. If -n *workdir* is given, the location of the secret file and the address:port are looked up in shared memory. If neither is given, *vinyladm* uses the -n defaults documented for *[vinyld(1)](/vinyld/1.md)*.

If a command is given, the command and arguments are sent over the CLI connection and the result returned on stdout.

If no command argument is given *vinyladm* will pass commands and replies between the CLI socket and stdin/stdout.

## OPTIONS

- **-h**

  Print program usage and exit.

- **-n** *workdir*

  Specify the Vinyl Cache working directory of the instance to attach to. See *[vinyld(1)](/vinyld/1.md)* **-n** option documentation for additional information and defaults.

- **-p**

  Force *pass* mode and make the output follow the VCLI protocol. This disables command-history/command-completion and makes it easier for programs to parse the response(s).

- **-S** *secretfile*

  Specify the authentication secret file. This should be the same -S argument as was given to **vinyld**. Only processes which can read the contents of this file, will be able to authenticate the CLI connection.

- **-T** *\<address:port\>*

  Connect to the management interface at the specified address and port.

- **-t** *timeout*

  Wait no longer than this many seconds for an operation to finish.

The syntax and operation of the actual CLI interface is described in the *[vinyl-cli(7)](/vinyl-cli/7.md)* manual page. Parameters are described in *[vinyld(1)](/vinyld/1.md)* manual page.

Additionally, a summary of commands can be obtained by issuing the *help* command, and a summary of parameters can be obtained by issuing the *param.show* command.

## EXIT STATUS

If a command is given, the exit status of the *vinyladm* utility is zero if the command succeeded, and non-zero otherwise.

## EXAMPLES

Some ways you can use vinyladm:

```
vinyladm -T localhost:999 -S /var/db/secret vcl.use foo
echo vcl.use foo | vinyladm -T localhost:999 -S /var/db/secret
echo vcl.use foo | ssh vhost vinyladm -T localhost:999 -S /var/db/secret
```

## SEE ALSO

- •

  *[vinyld(1)](/vinyld/1.md)*

- •

  *[vinyl-cli(7)](/vinyl-cli/7.md)*

## AUTHORS

The *vinyladm* utility and this manual page were written by Cecilie Fritzvold. This man page has later been modified by Per Buer, Federico G. Schwindt and Lasse Karstensen.