# GoCardless CLI

Source: https://docs.gocardless.com/docs/developer-resources/gc-cli

# GoCardless CLI

`gocardless` is the official GoCardless command-line interface. It's simple to install, works on macOS, Windows, and Linux, and lets you:

- Create, retrieve, update, or delete GC resources in test mode (e.g. create a payment)
- Stream real-time API requests and events (webhooks) from your account
- Trigger events to test your webhooks integration

> **Info:**
> The GC CLI is currently available in the Sandbox environment only. Production support is coming
>   soon.

## Installation

          ```
brew install gocardless/taps/cli
```),
    },
    
              releases page.
            Unzip: tar -xvf gc-cli_<version>_macOS_<arch>.tar.gzMove ./gocardlessto a location on your PATH(typically
              /usr/local/bin).
            The arm64build is for Apple Silicon (M1+), x86_64is for
            Intel Macs.
          ),
    },
    
            releases page.
          Unzip and move gocardless.exeto a directory on your PATH.
          ),
    },
    
            releases page.
          Unzip: tar -xvf gc-cli_<version>_Linux_<arch>.tar.gzMove ./gocardlessto a directory on your PATH.
          ),
    },
    Pass commands as arguments. See the
            releases pagefor the
            latest version.
          ),
    },
  ]}
/>

## Log in

After installing, run `gocardless login` to grant the CLI access to your merchant account. This opens a browser authorisation page.

```bash
gocardless login
```

> **Info:**
> If you don't have a Sandbox account yet, [sign up
>   here](https://manage-sandbox.gocardless.com/signup).

For partner integrations, authenticate with an existing app using the `--app` flag:

```bash
gocardless login --app AP0001
```

## Run your first command

Fetch a list of resources using the `list` command. For example, to list mandates:

```bash
gocardless list mandates
```

```json

  ],
  "meta": ,
    "limit": 50
  }
}
```

## What's next?

  
#### [Testing Webhooks (CLI)](/docs/developer-resources/gc-cli/testing-webhooks-cli)

Listen for events and forward webhooks to your local server.

  
#### [CLI Reference](/docs/developer-resources/gc-cli/cli-reference)

Full reference for all `gocardless` commands and flags.