From 23a92ffa90bf5cfd6feab169175e5a7693170dbe Mon Sep 17 00:00:00 2001 From: Altynbek Orumbayev Date: Mon, 25 Mar 2024 15:20:50 +0100 Subject: [PATCH] chore: merge conflicts --- docs/cli/index.md | 169 +++++++------------------ tests/test_root.test_help.approved.txt | 3 + 2 files changed, 48 insertions(+), 124 deletions(-) diff --git a/docs/cli/index.md b/docs/cli/index.md index e0b6843e..7e65d1c3 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -7,19 +7,8 @@ - [-v, --verbose](#-v---verbose) - [--color, --no-color](#--color---no-color) - [--skip-version-check](#--skip-version-check) - - [bootstrap](#bootstrap) - - [Options](#options-1) - - [--force](#--force) - - [all](#all) - - [Options](#options-2) - - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci) - - [env](#env) - - [Options](#options-3) - - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci-1) - - [npm](#npm) - - [poetry](#poetry) - [compile](#compile) - - [Options](#options-4) + - [Options](#options-1) - [-v, --version ](#-v---version-) - [py](#py) - [Arguments](#arguments) @@ -29,62 +18,53 @@ - [PUYAPY_ARGS](#puyapy_args-1) - [completions](#completions) - [install](#install) - - [Options](#options-5) + - [Options](#options-2) - [--shell ](#--shell-) - [uninstall](#uninstall) - - [Options](#options-6) + - [Options](#options-3) - [--shell ](#--shell--1) - [config](#config) - [version-prompt](#version-prompt) - [Arguments](#arguments-2) - [ENABLE](#enable) - - [deploy](#deploy) - - [Options](#options-7) - - [-C, --command ](#-c---command-) - - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci-2) - - [-P, --path ](#-p---path-) - - [--deployer ](#--deployer-) - - [--dispenser ](#--dispenser-) - - [Arguments](#arguments-3) - - [ENVIRONMENT_NAME](#environment_name) - [dispenser](#dispenser) - [fund](#fund) - - [Options](#options-8) + - [Options](#options-4) - [-r, --receiver ](#-r---receiver-) - [-a, --amount ](#-a---amount-) - [--whole-units](#--whole-units) - [limit](#limit) - - [Options](#options-9) + - [Options](#options-5) - [--whole-units](#--whole-units-1) - [login](#login) - - [Options](#options-10) + - [Options](#options-6) - [--ci](#--ci) - [-o, --output ](#-o---output-) - [-f, --file ](#-f---file-) - [logout](#logout) - [refund](#refund) - - [Options](#options-11) + - [Options](#options-7) - [-t, --txID ](#-t---txid-) - [doctor](#doctor) - - [Options](#options-12) + - [Options](#options-8) - [-c, --copy-to-clipboard](#-c---copy-to-clipboard) - [explore](#explore) - - [Arguments](#arguments-4) + - [Arguments](#arguments-3) - [NETWORK](#network) - [generate](#generate) - [client](#client) - - [Options](#options-13) + - [Options](#options-9) - [-o, --output ](#-o---output--1) - [-l, --language ](#-l---language-) - - [Arguments](#arguments-5) + - [Arguments](#arguments-4) - [APP_SPEC_PATH_OR_DIR](#app_spec_path_or_dir) - [goal](#goal) - - [Options](#options-14) + - [Options](#options-10) - [--console](#--console) - - [Arguments](#arguments-6) + - [Arguments](#arguments-5) - [GOAL_ARGS](#goal_args) - [init](#init) - - [Options](#options-15) + - [Options](#options-11) - [-n, --name ](#-n---name-) - [-t, --template ](#-t---template-) - [--template-url ](#--template-url-) @@ -100,63 +80,63 @@ - [console](#console) - [explore](#explore-1) - [logs](#logs) - - [Options](#options-16) + - [Options](#options-12) - [--follow, -f](#--follow--f) - [--tail ](#--tail-) - [reset](#reset) - - [Options](#options-17) + - [Options](#options-13) - [--update, --no-update](#--update---no-update) - [start](#start) - - [Options](#options-18) + - [Options](#options-14) - [-n, --name ](#-n---name--1) - [status](#status) - [stop](#stop) - [project](#project) - [bootstrap](#bootstrap) - - [Options](#options-14) - - [--force](#--force) - [Options](#options-15) + - [--force](#--force) + - [Options](#options-16) - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci) - [-p, --project-name ](#-p---project-name-) - [-t, --type ](#-t---type-) - - [Options](#options-16) + - [Options](#options-17) - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci-1) - [deploy](#deploy) - - [Options](#options-17) + - [Options](#options-18) - [-C, --command ](#-c---command-) - [--interactive, --non-interactive, --ci](#--interactive---non-interactive---ci-2) - [-P, --path ](#-p---path-) - [--deployer ](#--deployer-) - [--dispenser ](#--dispenser-) - [-p, --project-name ](#-p---project-name--1) - - [Arguments](#arguments-4) + - [Arguments](#arguments-6) - [ENVIRONMENT_NAME](#environment_name) - [link](#link) - - [Options](#options-18) + - [Options](#options-19) - [-p, --project-name ](#-p---project-name--2) - [-l, --language ](#-l---language--1) - [-a, --all](#-a---all) - [-f, --fail-fast](#-f---fail-fast) - [list](#list) - - [Arguments](#arguments-5) + - [Arguments](#arguments-7) - [WORKSPACE_PATH](#workspace_path) - [run](#run) - [task](#task) - [analyze](#analyze) - - [Options](#options-19) + - [Options](#options-20) - [-r, --recursive](#-r---recursive) - [--force](#--force-1) - [--diff](#--diff) - [-o, --output ](#-o---output--2) - [-e, --exclude ](#-e---exclude-) - - [Arguments](#arguments-7) + - [Arguments](#arguments-8) - [INPUT_PATHS](#input_paths) - [ipfs](#ipfs) - - [Options](#options-20) + - [Options](#options-21) - [-f, --file ](#-f---file--1) - [-n, --name ](#-n---name--2) - [mint](#mint) - - [Options](#options-21) + - [Options](#options-22) - [--creator ](#--creator-) - [-n, --name ](#-n---name--3) - [-u, --unit ](#-u---unit-) @@ -168,37 +148,37 @@ - [--nft, --ft](#--nft---ft) - [-n, --network ](#-n---network-) - [nfd-lookup](#nfd-lookup) - - [Options](#options-22) + - [Options](#options-23) - [-o, --output ](#-o---output--3) - - [Arguments](#arguments-8) + - [Arguments](#arguments-9) - [VALUE](#value) - [opt-in](#opt-in) - - [Options](#options-23) + - [Options](#options-24) - [-a, --account ](#-a---account-) - [-n, --network ](#-n---network--1) - - [Arguments](#arguments-9) + - [Arguments](#arguments-10) - [ASSET_IDS](#asset_ids) - [opt-out](#opt-out) - - [Options](#options-24) + - [Options](#options-25) - [-a, --account ](#-a---account--1) - [--all](#--all) - [-n, --network ](#-n---network--2) - - [Arguments](#arguments-10) + - [Arguments](#arguments-11) - [ASSET_IDS](#asset_ids-1) - [send](#send) - - [Options](#options-25) + - [Options](#options-26) - [-f, --file ](#-f---file--2) - [-t, --transaction ](#-t---transaction-) - [-n, --network ](#-n---network--3) - [sign](#sign) - - [Options](#options-26) + - [Options](#options-27) - [-a, --account ](#-a---account--2) - [-f, --file ](#-f---file--3) - [-t, --transaction ](#-t---transaction--1) - [-o, --output ](#-o---output--4) - [--force](#--force-2) - [transfer](#transfer) - - [Options](#options-27) + - [Options](#options-28) - [-s, --sender ](#-s---sender-) - [-r, --receiver ](#-r---receiver--1) - [--asset, --id ](#--asset---id-) @@ -206,28 +186,28 @@ - [--whole-units](#--whole-units-2) - [-n, --network ](#-n---network--4) - [vanity-address](#vanity-address) - - [Options](#options-28) + - [Options](#options-29) - [-m, --match ](#-m---match-) - [-o, --output ](#-o---output--5) - [-a, --alias ](#-a---alias-) - [--file-path ](#--file-path-) - [-f, --force](#-f---force) - - [Arguments](#arguments-11) + - [Arguments](#arguments-12) - [KEYWORD](#keyword) - [wallet](#wallet) - - [Options](#options-29) + - [Options](#options-30) - [-a, --address ](#-a---address-) - [-m, --mnemonic](#-m---mnemonic) - [-f, --force](#-f---force-1) - - [Arguments](#arguments-12) - - [ALIAS_NAME](#alias_name) - [Arguments](#arguments-13) + - [ALIAS_NAME](#alias_name) + - [Arguments](#arguments-14) - [ALIAS](#alias) - - [Options](#options-30) + - [Options](#options-31) - [-f, --force](#-f---force-2) - - [Arguments](#arguments-14) + - [Arguments](#arguments-15) - [ALIAS](#alias-1) - - [Options](#options-31) + - [Options](#options-32) - [-f, --force](#-f---force-3) # algokit @@ -258,65 +238,6 @@ Force enable or disable of console output styling. ### --skip-version-check Skip version checking and prompting. -## bootstrap - -Expedited initial setup for any developer by installing and configuring dependencies and other -key development environment setup activities. - -```shell -algokit bootstrap [OPTIONS] COMMAND [ARGS]... -``` - -### Options - - -### --force -Continue even if minimum AlgoKit version is not met - -### all - -Runs all bootstrap sub-commands in the current directory and immediate sub directories. - -```shell -algokit bootstrap all [OPTIONS] -``` - -### Options - - -### --interactive, --non-interactive, --ci -Enable/disable interactive prompts. If the CI environment variable is set, defaults to non-interactive - -### env - -Copies .env.template file to .env in the current working directory and prompts for any unspecified values. - -```shell -algokit bootstrap env [OPTIONS] -``` - -### Options - - -### --interactive, --non-interactive, --ci -Enable/disable interactive prompts. If the CI environment variable is set, defaults to non-interactive - -### npm - -Runs npm install in the current working directory to install Node.js dependencies. - -```shell -algokit bootstrap npm [OPTIONS] -``` - -### poetry - -Installs Python Poetry (if not present) and runs poetry install in the current working directory to install Python dependencies. - -```shell -algokit bootstrap poetry [OPTIONS] -``` - ## compile Compile smart contracts and smart signatures written in a supported high-level language diff --git a/tests/test_root.test_help.approved.txt b/tests/test_root.test_help.approved.txt index 3dc0de36..778cf9e5 100644 --- a/tests/test_root.test_help.approved.txt +++ b/tests/test_root.test_help.approved.txt @@ -14,6 +14,9 @@ Options: -h, --help Show this message and exit. Commands: + compile Compile smart contracts and smart signatures written in a + supported high-level language to a format deployable on the + Algorand Virtual Machine (AVM). completions Install and Uninstall AlgoKit shell integrations. config Configure AlgoKit settings. dispenser Interact with the AlgoKit TestNet Dispenser.