microsoft/typespec

Public

mirrored from https://github.com/microsoft/typespecAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
33d83ea24ba2f6df7d485c85eddc310754a0f5d6

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

docs/introduction/usage.md

31lines · modepreview

---
id: usage
title: Usage
---

# Usage

See full usage documentation by typing `cadl --help`:

```bash
>cadl --help
Cadl compiler v0.36.1

cadl <command>

Commands:
  cadl compile <path>       Compile Cadl source.
  cadl code                 Manage VS Code Extension.
  cadl vs                   Manage Visual Studio Extension.
  cadl format <include...>  Format given list of Cadl files.
  cadl init [templatesUrl]  Create a new Cadl project.
  cadl install              Install cadl dependencies
  cadl info                 Show information about current Cadl compiler.

Options:
  --help     Show help                                                 [boolean]
  --debug    Output debug log messages.               [boolean] [default: false]
  --pretty   Enable color and formatting in Cadl's output to make compiler error
             s easier to read.                         [boolean] [default: true]
  --version  Show version number                                       [boolean]
```