fa CLI

Use the CLI (Command Line Interface) to query Font Awesome icons and releases, search and download your kits, and more.

Early Days

We're just getting started with the fa CLI and would love to hear what you think. Got feedback, ideas, or running into issues? Drop us a line at hello@fontawesome.com.

Pro Tip: Use the fa CLI to level up Font Awesome agent tools in your AI coding assistants, giving them the power to read and search your kits and account metadata to find the perfect icons for your projects.

Install

curl --proto '=https' --tlsv1.2 -fsSL https://fontawesome.com/fa-cli/install.sh | bash

Usage

Here are some of the things you can do with the fa CLI:

Command
 Description
fa login Log in to your fontawesome.com account to access your kits and account
fa search Search for icons across different versions of Font Awesome, or within your kits, including custom icons. Searches on kits are limited to the kit's subset.
fa kits List your kits and their metadata
fa kit show Show details of a specific kit, including custom icons (aka "icon uploads")
fa kit icons List official icons in a specific kit, according to its subset.
fa kit icon Get a specific official icon in a specific kit.
fa kit family-styles List the family-styles in a specific kit, according to its subset.
fa kit family-style Select a particular family-style from a specific kit.
fa kit download Download a kit
fa icons List all icons in some version of Font Awesome
fa icon-packs Show all metadata about Icon Collections, Icon Packs, and Visual Tags for some version of Font Awesome
fa releases List all releases of Font Awesome

Examples

Search icons for "coffee" in the kit with token 8812e4e21d, returning only icons within the kit's subset, including custom icons, and include their SVG data in html format:

fa search --kit-token 8812e4e21d --svg-format html --query 'coffee'

Download the Web-type archive of the kit with token 8812e4e21d and unzip its contents under the kit directory:

fa kit download --kit-token 8812e4e21d --unzip --output kit web

Kit downloads and SVG icon data are only available for accounts with access to downloads, such as Pro and Pro Plus.

    No results