Skip to content
Juan Gonzalez-Gomez edited this page Mar 28, 2024 · 34 revisions

Contents

Usage

apio install [OPTIONS] [PACKAGES]

Description

Install apio packages. By default it installs the latest stable version. Other versions can be installed using the following notation: package@version (Ex. [email protected])

Options

Flag Long Flag Description
-a --all Install all packages
-l --list List all available packages
-f --force Force the packages installation
-p --platform Set the platform [linux, linux_x86_64, linux_i686, linux_armv7l, linux_aarch64, windows, windows_amd64, windows_x86, darwin] (Advanced)

Packages

Package Installation Description
tools-oss-cad-suite apio install oss-cad-suite Selected binaries from the YosysHQ/oss-cad-suite project
examples apio install examples Verilog basic examples, pinouts, etc
drivers apio install drivers Drivers tools (only for Windows)
gtkwave apio install gtkwave Simulation viewer. GTKWave project (only for Windows)

Examples

1. Install oss-cad-suite and examples packages

apio install oss-cad-suite examples

The latest stable versions are installed (0.0.9 and 0.0.36 in this example):

2. Install oss-cad-suite package version 0.0.8

apio install [email protected]

3. Show all available/installed packages

$ apio install --list

4. Install and update all packages

apio install --all

The packages are only installed if they are not in the latest version

5. Install the drivers package for windows in a linux platform

This is usually done by the developers, to test if the correct package is downloaded

apio install drivers --platform windows_amd64

Folders

The apio home folder by default is .apio, located in the user home folder. The full path depends on the operating system and the user who installed apio

  • Ex. in Linux: /home/obijuan/.apio
  • Ex. in Windows: `` (TODO)

The packages are installed in the packages folder, inside the apio home folder

  • Ex. in Linux: /home/obijuan/.apio/packages
  • Ex. in Windows: `` (TODO)

Clone this wiki locally