---
schema_version: "1"
id: 5b798c0b0390321f096c0b03d289eb80cc7f096f983bc5d31eff4878139a2477
title: Getting Started with API Catalog CLI
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/exchange/apicat-get-started.md
canonical_url: https://docs.mulesoft.com/exchange/apicat-get-started
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 2252ed2b89171b8d9429f0adb5be4e029ca392e9a13958f29ceac56b60853d19
description: MuleSoft Documentation Site
latest: true
---
---
product: Exchange
---

# Getting Started with API Catalog CLI

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

After you become familiar with the API Catalog CLI concepts covered in
[Autocataloging APIs Using API Catalog CLI](https://docs.mulesoft.com/exchange/apicat-about-api-catalog-cli), you are ready to get
started autocataloging your APIs.

## Before You Begin

To grant permission to run the API Catalog CLI commands that interact with Anypoint Platform:

- Enable **API Catalog Contributor**.

- If you are authenticating using a connected app, set the **View Environment** scope to the main
  environment for your organization.

> [!NOTE] Permissions must be set in **Access Management** by an Anypoint Platform user with
> administrative permission.

See the Access Management documentation for details on
[managing permissions](https://docs.mulesoft.com/access-management/managing-permissions).

## Get Started with API Catalog CLI

To get started with API Catalog CLI:

1.  [Install](https://docs.mulesoft.com/exchange/apicat-install-api-catalog-cli) API Catalog CLI.

2.  [Get familiar with the general use of API Catalog](https://docs.mulesoft.com/exchange/apicat-use-api-catalog-cli), such as how to
    pass authentication information and how to use the general command flags.

3.  [Create a descriptor file](https://docs.mulesoft.com/exchange/apicat-create-descriptor-file-cli) to identify the APIs to publish.

4.  [Catalog an asset](https://docs.mulesoft.com/exchange/apicat-publish-using-api-catalog-cli) using API Catalog CLI and view it in
    Anypoint Exchange.

> [!TIP] Consider testing the process end-to-end locally by running the commands at a command prompt
> before adding the commands to your CI/CD pipeline or custom scripts.

## See Also

- [Autocataloging APIs Using API Catalog CLI](https://docs.mulesoft.com/exchange/apicat-about-api-catalog-cli)