feat: linking and project listing commands

[aorumbayev]

Proposed Changes

Command Line Interface Enhancements

• List Command Support: Introduces a simple ls command for browsing currently available projects in the workspace, enhancing navigation and project visibility.
• Link Command Support: Simplifies the use of the algokit generate command by allowing interactive invocation or exporting typed clients from sibling contract projects, streamlining the development workflow.

Deployment and Bootstrap Enhancements

• Deployment Flexibility: Enables deployment from the workspace root by specifying a project name with algokit deploy, allowing for more centralized management of projects.
• Bootstrap Enhancements: Adds the capability to use algokit bootstrap with filters by project type or name, facilitating targeted initialization of projects.

Run Command Improvements

• Environment File Specification: Enhances the run command to support an env_file field, prioritizing the loading of custom environment files. This feature defaults to .env files if present and ultimately loads the global context, ensuring environmental configurations are accurately applied.
• Filtering Capabilities: Introduces filtering by project-type and name in run commands when orchestrated from the root, allowing for more refined execution control.
• Multiple Commands Support: Adds the ability to specify multiple commands under run, offering a cross-platform alternative to Unix-like command chaining. This ensures commands are valid and resolved before execution, enhancing command flexibility and reliability.

GitHub Actions and Workspace Management

• GitHub Files Resolution: Addresses the handling of .github files for standalone projects. With the workspace flag enabled, GitHub actions within standalone projects are not discoverable by default -> hence the fix. Implements a move operation for any .github folder content at the project's root to the workspace's root .github folder post-initialization. This change resolves a bug from the 1.12.x release that required manual movement of standalone production preset templates to the workspace structure.

TODO

• - snap shot tests for link and list commands, edge cases for deploy and boostrap
• - documentation

Related template PRs:

algorandfoundation/algokit-react-frontend-template#27
algorandfoundation/algokit-python-template#7
algorandfoundation/algokit-base-template#3
algorandfoundation/algokit-fullstack-template#22

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/algokit
__init__.py	15	7	53%	6–13, 17–24, 32–34
__main__.py	4	4	0%	1–7
src/algokit/cli
__init__.py	45	1	98%	33
completions.py	108	2	98%	83, 98
dispenser.py	121	1	99%	77
doctor.py	48	3	94%	142–144
explore.py	50	12	76%	34–39, 41–46
generate.py	69	3	96%	76–77, 142
goal.py	44	1	98%	71
init.py	299	42	86%	396–397, 460–483, 498, 501–503, 514, 518, 574, 600, 629, 662, 671–673, 676–681, 694, 713, 725–726, 743–746
localnet.py	119	15	87%	74–78, 111, 123, 138–148, 161, 206, 227–228
task.py	34	3	91%	25–28
src/algokit/cli/common
utils.py	26	2	92%	120, 123
src/algokit/cli/project
deploy.py	99	20	80%	47, 49, 101, 124, 146–148, 227, 234, 248–256, 259–268
link.py	88	16	82%	60, 65–66, 88–92, 102–107, 135–136, 198–199, 203
list.py	27	2	93%	47–52
run.py	47	7	85%	39, 72, 163, 177–181
src/algokit/cli/tasks
analyze.py	81	1	99%	81
assets.py	82	13	84%	65–66, 72, 74–75, 105, 119, 125–126, 132, 134, 136–137
ipfs.py	51	8	84%	52, 80, 92, 94–95, 105–107
mint.py	66	4	94%	48, 70, 91, 250
send_transaction.py	65	10	85%	52–53, 57, 89, 158, 170–174
sign_transaction.py	59	8	86%	21, 28–30, 71–72, 109, 123
transfer.py	39	3	92%	26, 90, 117
utils.py	99	45	55%	26–34, 40–43, 75–76, 100–101, 125–133, 152–162, 209, 258–259, 279–290, 297–299
vanity_address.py	56	10	82%	41, 45–48, 112, 114, 121–123
wallet.py	79	4	95%	21, 66, 136, 162
src/algokit/core
conf.py	57	9	84%	12, 24, 28, 36, 38, 73–75, 80
dispenser.py	202	26	87%	91, 123–124, 141–149, 191–192, 198–200, 218–219, 259–260, 318, 332–334, 345–346, 356, 369, 384
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	48	3	94%	44, 81, 99
goal.py	60	3	95%	30–31, 41
init.py	34	6	82%	48, 52–57, 65
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	98
sandbox.py	218	18	92%	62, 73–75, 96, 142–149, 160, 457, 473, 498, 506
typed_client_generation.py	80	5	94%	55–57, 70, 75
utils.py	133	34	74%	46–47, 51–70, 131, 134, 140–154, 171–173, 236
version_prompt.py	92	14	85%	37–38, 68, 87–90, 108, 118–125, 148
src/algokit/core/project
__init__.py	53	10	81%	50, 86, 145, 161–170
bootstrap.py	122	8	93%	48, 126–127, 149, 176, 208–210
deploy.py	54	9	83%	61–64, 73–75, 79, 84
run.py	115	15	87%	82, 87, 96–97, 132–133, 137–138, 142, 146, 247–255, 270
src/algokit/core/tasks
analyze.py	93	3	97%	105–112, 187
ipfs.py	63	7	89%	58–64, 140, 144, 146, 152
nfd.py	49	13	73%	25, 31, 34–41, 70–72, 99–101
vanity_address.py	90	34	62%	49–50, 54, 59–75, 92–108, 128–131
wallet.py	71	5	93%	37, 129, 155–157
src/algokit/core/tasks/mint
mint.py	78	10	87%	123–133, 187
models.py	90	11	88%	50, 52, 57, 71–74, 85–88
TOTAL	4043	505	88%

Tests	Skipped	Failures	Errors	Time
437	0 💤	0 ❌	0 🔥	24.755s ⏱️

[aorumbayev]

@PhearZero @joe-p @Loedn @iskysun96 - available from branch for any further feedback. To test this out use:

pipx install git+https://github.com/algorandfoundation/algokit-cli@feat/command_orchestration

Please note only react/puya and their fullstack combo are currently updated to latest, beaker is to be updated after puya is reviewed, for tealscript ill add a simple build/test run declarations into toml @joe-p but for the rest refer to official templates to get tealscript template codebase up to date with latest conventions (notion of presets, tests, ci/cd, code tours, generators etc).

[neilcampbell]

It appears that this will only render if there are files found in the project .github folder.
To me this should be printed always at the start and we should replace this message with something like below:

Failed to move all files within your project's .githubfolder to the workspace root. Please review any files that remain in your project's.githubfolder and manually include in the root.github directory as required.