Apio - FPGAwars/apio GitHub Wiki

Contents

Usage

apio [OPTIONS] COMMAND [ARGS]

Description

Apio main command. Execute apio to see the help:

$ apio
Usage: apio [OPTIONS] COMMAND [ARGS]...

  Work with FPGAs with ease

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Project commands:
  build      Synthesize the bitstream.
  clean      Clean the previous generated files.
  graph      Generate a a visual graph of the verilog code.
  lint       Lint the verilog code.
  sim        Launch the verilog simulation.
  test       Launch the verilog testbench testing.
  time       Bitstream timing analysis.
  upload     Upload the bitstream to the FPGA.
  verify     Verify the verilog code.

Setup commands:
  drivers    Manage FPGA boards drivers.
  init       Manage apio projects.
  install    Install apio packages.
  uninstall  Uninstall packages.

Utility commands:
  boards     Manage FPGA boards.
  config     Apio configuration.
  examples   Manage verilog examples.
  raw        Execute commands directly from the Apio packages
  system     System tools.
  upgrade    Check the latest Apio version.

Options

Option Description
--version Show the version of Apio

Project Commands

Setup commands

Utility Commands

Examples

1. Show the apio version

apio --version

$ apio --version
apio, version 0.9.2