"lib/parsers/src/vscode:/vscode.git/clone" did not exist on "6e0d62d74f5b58f1bd0bbb078134f79ad9350366"
cli_overview.md 2.58 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<!--
SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES.
All rights reserved.
SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# About the Dynamo Command Line Interface

21
The Dynamo CLI serves, containerizes, and deploys Dynamo applications efficiently. It provides intuitive commands to manage your Dynamo services.
22
23
24
25
26
27
28

## CLI Capabilities

With the Dynamo CLI, you can:

* Chat with models quickly using `run`
* Serve multiple services locally using `serve`
29
* Package your services into archive (called `dynamo artifact`) using `build`
30
* Deploy pipelines to Dynamo Cloud using `deploy`
31
32
33
34
35

## Commands

### `run`

36
Use `run` to start an interactive chat session with a model. This command executes the `dynamo-run` Rust binary under the hood. For more details, see [Running Dynamo](dynamo_run.md).
37

38
#### Example
39
```bash
40
dynamo-run deepseek-ai/DeepSeek-R1-Distill-Qwen-1.5B
41
42
43
44
```

### `serve`

45
Use `serve` to run your defined inference graph locally. You'll need to specify your file and intended class using the file:Class syntax. For more details, see [Serving Inference Graphs](dynamo_serve.md).
46

47
#### Usage
48
49
50
51
```bash
dynamo serve [SERVICE]
```

52
#### Arguments
53
* `SERVICE`: Specify the service to start using file:Class syntax
54

55
#### Flags
56
57
58
59
60
* `--file`/`-f`: Path to optional YAML configuration file. For configuration examples, see the [SDK docs](../API/sdk.md)
* `--dry-run`: Print the dependency graph and values without starting services
* `--service-name`: Start only the specified service name
* `--working-dir`: Set the directory for finding the Service instance
* Additional flags following Class.key=value pattern are passed to the service constructor. For details, see the configuration section of the [SDK docs](../API/sdk.md)
61

62
#### Example
63
64
```bash
cd examples
65
# Start the Frontend, Middle, and Backend components
66
67
dynamo serve hello_world:Frontend

68
69
# Start only the Middle component in the graph that is discoverable from the Frontend service
dynamo serve --service-name Middle hello_world:Frontend
70
71
```

72
For a detailed deployment example, see [Operator Deployment](dynamo_deploy/operator_deployment.md).