Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

Latest commit

 

History

History
70 lines (48 loc) · 1.69 KB

shell.md

File metadata and controls

70 lines (48 loc) · 1.69 KB
title shell
hide_title true
hide_table_of_contents false
keywords
stackql
stackql-deploy
infrastructure-as-code
configuration-as-data
tags
stackql
stackql-deploy
infrastructure-as-code
configuration-as-data
description Documentation for the shell command in StackQL Deploy
image /img/stackql-cover.png

shell

Command used to launch the StackQL interactive shell.


Syntax

stackql-deploy shell [FLAGS]


Optional Flags

Flag Description Example
--download-dir Custom download directory for StackQL /etc/stackql
--custom-registry Custom StackQL provider registry URL https://myreg

:::info

The shell command launches the interactive StackQL shell. If the stackql binary is not found in the provided paths, the command will fail with an error.

:::


Examples

Launch the StackQL shell using the default binary location

This command attempts to launch the StackQL shell using the binary location managed by the pystackql package:

stackql-deploy shell

Launch the StackQL shell from a custom download directory

Specify a custom directory where the stackql binary is downloaded and run the StackQL shell:

stackql-deploy shell --download-dir /usr/local/bin/stackql

Use a custom registry URL

Launch the StackQL shell using a custom StackQL provider registry:

stackql-deploy shell --custom-registry https://mycustomregistry.com