|
| 1 | +# SnowDev CLI Documentation |
| 2 | + |
| 3 | +SnowDev is a CLI tool designed to deploy Snowflake components such as UDFs, Stored Procedures, Streamlit apps, and tasks. Below is the detailed documentation of all the commands available in the SnowDev CLI. |
| 4 | + |
| 5 | +## 1. `init` |
| 6 | +- **Description**: Initialize the project structure. |
| 7 | +- **Usage**: `snowdev init` |
| 8 | + |
| 9 | +## 2. `new` |
| 10 | +- **Description**: Create a new component. |
| 11 | +- **Usage**: `snowdev new [OPTIONS]` |
| 12 | +- **Options**: |
| 13 | + - `--udf <udf_name>`: The name of the UDF. |
| 14 | + - `--sproc <sproc_name>`: The name of the stored procedure. |
| 15 | + - `--streamlit <streamlit_name>`: The name of the Streamlit app. |
| 16 | + - `--task <task_name>`: The name of the task. |
| 17 | + |
| 18 | +## 3. `test` |
| 19 | +- **Description**: Test the deployment. |
| 20 | +- **Usage**: `snowdev test [OPTIONS]` |
| 21 | +- **Options**: |
| 22 | + - `--udf <udf_name>`: The name of the UDF. |
| 23 | + - `--sproc <sproc_name>`: The name of the stored procedure. |
| 24 | + |
| 25 | +## 4. `upload` |
| 26 | +- **Description**: Upload static content to stage, only for zipped external packages. |
| 27 | +- **Usage**: `snowdev upload` |
| 28 | + |
| 29 | +## 5. `add` |
| 30 | +- **Description**: Add a package and optionally upload. |
| 31 | +- **Usage**: `snowdev add --package <package_name>` |
| 32 | + |
| 33 | +## 6. `ai` |
| 34 | +- **Description**: Interact with AI components. Run embeddings or create new AI components. |
| 35 | +- **Usage**: `snowdev ai [OPTIONS]` |
| 36 | +- **Options**: |
| 37 | + - `--udf <udf_name>`: The name of the UDF. |
| 38 | + - `--sproc <sproc_name>`: The name of the stored procedure. |
| 39 | + - `--streamlit <streamlit_name>`: The name of the Streamlit app. |
| 40 | + - `--embed`: Run the embeddings. |
| 41 | + - `--task <task_name>`: The name of the task. |
| 42 | + |
| 43 | +## 7. `deploy` |
| 44 | +- **Description**: Deploy components. |
| 45 | +- **Usage**: `snowdev deploy [OPTIONS]` |
| 46 | +- **Options**: |
| 47 | + - `--udf <udf_name>`: The name of the UDF. |
| 48 | + - `--sproc <sproc_name>`: The name of the stored procedure. |
| 49 | + - `--streamlit <streamlit_name>`: The name of the Streamlit app. |
| 50 | + - `--task <task_name>`: The name of the task. |
| 51 | + |
| 52 | +## 8. `task` |
| 53 | +- **Description**: Commands for tasks. Actions: resume, suspend, execute. |
| 54 | +- **Usage**: `snowdev task --name <task_name> --action <action>` |
| 55 | +- **Options**: |
| 56 | + - `--name <task_name>`: The name of the task. (Required) |
| 57 | + - `--action <action>`: The action to be performed on the task. Choices: resume, suspend, execute. (Required) |
0 commit comments