Install asciinema in seconds on [Ubuntu and other snap supported Linux distributions](https://snapcraft.io/docs/core/install) with:
snap install asciinema --classic
- [Installing via Pip](#installing-via-pip)
- [Installing on Linux](#installing-on-linux)
- [Installing on Linux as snap](#installing-on-linux-as-snap) (universal Linux package)
- [Installing on macOs](#installing-on-macos)
- [Installing on FreeBSD](#installing-on-freebsd)
- [Installing on OpenBSD](#installing-on-openbsd)
- [Running in Docker container](#running-in-docker-container)
- [Running from source](#running-from-source)
Installing a snap is very quick. Snaps contain all necessary dependencies required to run. The snap will get automatically updated when a new version is pushed to the store.
If you use other operating system and you can build a native package for it then
don't hesitate, do it and let us know. We have [Github
issue](https://github.com/asciinema/asciinema/issues/116) where we track new
releases and packaging progress.
## Python package
## Installing via Pip
asciinema is available on [PyPI](https://pypi.python.org/pypi/asciinema) and can
be installed with pip (Python 3 required):
sudo pip3 install asciinema
## Docker image
asciinema Docker image is based on Ubuntu 16.04 and has the latest version of
asciinema recorder pre-installed.
docker pull asciinema/asciinema
When running it don't forget to allocate a pseudo-TTY (`-t`), keep STDIN open
(`-i`) and mount config directory volume (`-v`):
docker run --rm -ti -v "$HOME/.config/asciinema":/root/.config/asciinema asciinema/asciinema
This is the universal installation method for all operating systems, which
always provides the latest version.
## Native packages
## Installing on Linux
### Arch Linux
@ -49,16 +48,6 @@ For Fedora >= 22:
sudo dnf install asciinema
### FreeBSD
Ports:
cd /usr/ports/textproc/asciinema && make install
Packages:
pkg install asciinema
### Gentoo Linux
emerge -av asciinema
@ -67,45 +56,69 @@ Packages:
nix-env -i asciinema
### OpenBSD
pkg_add asciinema
### openSUSE
zypper in asciinema
### OS X
### Ubuntu
sudo apt-add-repository ppa:zanchey/asciinema
sudo apt-get update
sudo apt-get install asciinema
## Installing on Linux as snap
Install asciinema in seconds on [Ubuntu and other snap supported Linux distributions](https://snapcraft.io/docs/core/install) with:
snap install asciinema --classic
Homebrew:
Installing a snap is very quick. Snaps contain all necessary dependencies required to run. The snap will get automatically updated when a new version is pushed to the store.
## Installing on macOS
### Homebrew
<%= render 'install_homebrew' %>
MacPorts:
### MacPorts
sudo port selfupdate && sudo port install asciinema
Nix:
### Nix
nix-env -i asciinema
### Ubuntu
## Installing on FreeBSD
sudo apt-add-repository ppa:zanchey/asciinema
sudo apt-get update
sudo apt-get install asciinema
### Ports
### No package for your operating system?
cd /usr/ports/textproc/asciinema && make install
If you use other operating system and you can build a native package for it then
don't hesitate, do it and let us know. We have [Github
issue](https://github.com/asciinema/asciinema/issues/116) where we track new
releases and packaging progress.
### Packages
pkg install asciinema
## Installing on OpenBSD
pkg_add asciinema
## Running in Docker container
asciinema Docker image is based on Ubuntu 16.04 and has the latest version of
asciinema recorder pre-installed.
docker pull asciinema/asciinema
When running it don't forget to allocate a pseudo-TTY (`-t`), keep STDIN open
(`-i`) and mount config directory volume (`-v`):
docker run --rm -ti -v "$HOME/.config/asciinema":/root/.config/asciinema asciinema/asciinema
## Running latest version from master
## Running from source
If none of the above works for you (or you want to help with development) just
clone the repo and run asciinema straight from the checkout:
clone the repo and run latest version of asciinema straight from the master
Marcin Kulik
8 years ago