github.com/iasthc/atlas/cmd/atlas@v0.0.0-20230523071841-73246df3f88d/doc.tmpl (about) 1 {{- define "header" -}} 2 --- 3 title: CLI Reference 4 id: cli-reference 5 slug: cli-reference 6 --- 7 {{- end }} 8 {{ define "body" }} 9 ## Introduction 10 11 This document serves as reference documentation for all available commands in the Atlas CLI. 12 Similar information can be obtained by running any atlas command with the `-h` or `--help` 13 flags. 14 15 For a more detailed introduction to the CLI capabilities, head over to the 16 [Getting Started](/getting-started/) page. 17 18 ## Distributed Binaries 19 20 The binaries distributed in official releases are released under the [Apache 2 License](https://github.com/ariga/atlas/blob/master/LICENSE). 21 If you would like to build Atlas from source follow the instructions [here](https://atlasgo.io/cli-reference#building-from-source). 22 23 ### Building from Source 24 25 If you would like to build Atlas from source without the UI code run: 26 ```shell 27 go get github.com/iasthc/atlas/cmd/atlas 28 ``` 29 {{ range .Blocks }} 30 {{ header .Depth }} {{ .CommandPath }} 31 32 {{ .Short }} 33 34 {{- if .UseLine }} 35 36 #### Usage 37 ``` 38 {{ .UseLine }} 39 ``` 40 {{- end }} 41 {{- if .Long }} 42 43 #### Details 44 {{ .Long }} 45 {{- end }} 46 {{ if .Example }} 47 #### Example 48 49 ``` 50 {{ .Example }} 51 ``` 52 {{- end }} 53 54 {{- $flags := .NonInheritedFlags }} 55 {{- if $flags.HasAvailableFlags }} 56 #### Flags 57 ``` 58 {{ $flags.FlagUsages }} 59 ``` 60 {{ end }} 61 {{ end }} 62 63 {{ end }}