Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
FABulous: an Embedded FPGA Framework and CAD Tools v2.0.0b5.dev9+gd7f16970c
Logo
FABulous: an Embedded FPGA Framework and CAD Tools v2.0.0b5.dev9+gd7f16970c
  • Getting Started
    • Quick start
    • Installation Method
      • venv based setup
      • uv based setup
      • Install Required CAD tools
      • docker based setup
      • Nix-based Development Environment
  • User Guide
    • Building your eFPGA
      • Fabric definition
      • Building fabric
      • FABulous Fabric Automation
    • Using the eFPGA
      • Synthesis
        • Yosys models
        • Yosys compilation
      • Place and Route
        • Nextpnr models
        • Nextpnr compilation
      • FASM to Bitstream
    • CLI Usage Guide
      • FABulous Environment Variables
    • Simulation and emulation
      • Simulation setup
      • Emulation setup
  • Development
  • Chip Gallery
  • Team and Contact
  • Publications
  • API Reference
    • FABulous
    • FABulous.FABulous
    • FABulous.FABulous_API
    • FABulous.FABulous_CLI.FABulous_CLI
    • FABulous.FABulous_CLI.cmd_synthesis
    • FABulous.FABulous_CLI.helper
    • FABulous.FABulous_CLI
    • FABulous.FABulous_settings
    • FABulous.custom_exception
    • FABulous.fabric_cad.gen_bitstream_spec
    • FABulous.fabric_cad.gen_design_top_wrapper
    • FABulous.fabric_cad.gen_npnr_model
    • FABulous.fabric_cad
    • FABulous.fabric_definition.Bel
    • FABulous.fabric_definition.ConfigMem
    • FABulous.fabric_definition.Fabric
    • FABulous.fabric_definition.Gen_IO
    • FABulous.fabric_definition.Port
    • FABulous.fabric_definition.SuperTile
    • FABulous.fabric_definition.Tile
    • FABulous.fabric_definition.Wire
    • FABulous.fabric_definition.Yosys_obj
    • FABulous.fabric_definition.define
    • FABulous.fabric_definition
    • FABulous.fabric_generator.code_generator.code_generator
    • FABulous.fabric_generator.code_generator.code_generator_VHDL
    • FABulous.fabric_generator.code_generator.code_generator_Verilog
    • FABulous.fabric_generator.code_generator
    • FABulous.fabric_generator.gds_generator.gen_io_pin_config_yaml
    • FABulous.fabric_generator.gds_generator.helper
    • FABulous.fabric_generator.gds_generator
    • FABulous.fabric_generator.gds_generator.script.fabric_io_place
    • FABulous.fabric_generator.gds_generator.script
    • FABulous.fabric_generator.gds_generator.script.odb_power
    • FABulous.fabric_generator.gds_generator.script.odb_protocol
    • FABulous.fabric_generator.gds_generator.script.tile_io_place
    • FABulous.fabric_generator.gds_generator.steps.add_buffer
    • FABulous.fabric_generator.gds_generator.steps.auto_diode
    • FABulous.fabric_generator.gds_generator.steps.condition_magic_drc
    • FABulous.fabric_generator.gds_generator.steps.custom_pdn
    • FABulous.fabric_generator.gds_generator.steps.extract_pdk_info
    • FABulous.fabric_generator.gds_generator.steps.fabric_IO_placement
    • FABulous.fabric_generator.gds_generator.steps
    • FABulous.fabric_generator.gds_generator.steps.odb_connect_power
    • FABulous.fabric_generator.gds_generator.steps.round_die_area
    • FABulous.fabric_generator.gds_generator.steps.tile_IO_placement
    • FABulous.fabric_generator.gds_generator.steps.tile_optimisation
    • FABulous.fabric_generator.gds_generator.steps.while_step
    • FABulous.fabric_generator.gen_fabric.fabric_automation
    • FABulous.fabric_generator.gen_fabric.gen_configmem
    • FABulous.fabric_generator.gen_fabric.gen_fabric
    • FABulous.fabric_generator.gen_fabric.gen_helper
    • FABulous.fabric_generator.gen_fabric.gen_switchmatrix
    • FABulous.fabric_generator.gen_fabric.gen_tile
    • FABulous.fabric_generator.gen_fabric.gen_top_wrapper
    • FABulous.fabric_generator.gen_fabric
    • FABulous.fabric_generator
    • FABulous.fabric_generator.parser
    • FABulous.fabric_generator.parser.parse_configmem
    • FABulous.fabric_generator.parser.parse_csv
    • FABulous.fabric_generator.parser.parse_hdl
    • FABulous.fabric_generator.parser.parse_switchmatrix
    • FABulous.geometry_generator.bel_geometry
    • FABulous.geometry_generator.fabric_geometry
    • FABulous.geometry_generator.geometry_gen
    • FABulous.geometry_generator.geometry_obj
    • FABulous.geometry_generator
    • FABulous.geometry_generator.port_geometry
    • FABulous.geometry_generator.sm_geometry
    • FABulous.geometry_generator.tile_geometry
    • FABulous.geometry_generator.wire_geometry
Back to top
View this page
Edit this page

CLI Usage GuideΒΆ

The FABulous command-line interface (CLI) provides a set of tools for generating eFPGA fabric projects directly from your terminal. This guide covers common commands, options, and typical workflows to help you get started quickly with fabric generation and project synthesis.

  • FABulous Environment Variables
    • Global Environment Variables
    • Project Specific Environment Variables
Next
FABulous Environment Variables
Previous
FASM to Bitstream
Copyright © 2021, University of Manchester
Made with Sphinx and @pradyunsg's Furo