# adl

**Repository Path**: mirrors_Azure/adl

## Basic Information

- **Project Name**: adl
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-03-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ADL

This project is a work in progress, more information will be provided at a later
date.

You can try a work-in-progress build of the compiler by following the steps in
the Installation section below.  Please feel free to [file
issues](https://github.com/Azure/adl/issues) for any issues you encounter while
using the preview.

## Installation

You can install the current preview build of ADL using Node.js (14+) and `npm`:

```
npm install -g @azure-tools/adl
```

ADL will now be accessible via the `adl` command in your shell.

## Usage

See full usage documentation by typing:

```
adl --help
```

You can launch ADL in one of two ways:

### Compiling a folder of ADL files to an OpenAPI 2.0 (Swagger) specification

You can compile a folder containing `.adl` files into a single OpenAPI document by
using the following command:

```
adl compile samples/petstore/
```

You can now examine the emitted OpenAPI document in `./adl-output/openapi.json`.

### Generating a TypeScript client from a folder of ADL files

You can compile a folder containing `.adl` files into a single OpenAPI document by
using the following command:

```
adl generate --client samples/petstore/
```

Parameters for generating clients in other languages will be added soon.