A CLI helper for writing killercoda scenarios and managing steps
Project description
killercoda-cli
Table of Contents
Installation
pip install killercoda-cli
[!NOTE]
If there is an installation permissions error [Error 13], consider installing with
--user
flag or adding./local/bin
to thePATH
variable.
Introduction
The interactive killercoda scenarios are a great way learn new technologies in an hands-on approach. However, creating the scenarios and managing can be tedious and time consuming.
The killercoda-cli
solves some of those problems by:
- Adding a new step after the existing last step and creating a directory for including foreground and background scripts placeholders.
- Renaming and re indexing step files and directories allowing for inserting a step in between existing steps and moving content down
- Updating the
index.json
file to reflect changes in step order and titles.
Documentation
Autogenerated API documentation generated in pdoc available at: https://piotr1215.github.io/killercoda-cli/killercoda_cli/cli.html.
Requirements
- The tool must be run in a directory containing step files or directories (e.g. step1.md, step2/).
- An
index.json
file must be present in the directory, which contains metadata about the steps.
Example usage
Suppose you have a scenario directory with the following structure:
.
├── index.json
├── step1.md
└── step2
└── step2.md
And you want to insert a new step between step1.md
and step2/
, titled "New Step".
- Run
killercoda-cli
. - Enter the title for the new step: "New Step".
- Enter the step number to insert the new step at: 2.
After running the tool, your directory structure will be updated to:
.
├── index.json
├── step1.md
├── step2
└── step2.md (previously step1.md content)
└── step3
└── step3.md (previously step2.md content)
The index.json
file will also be updated to include the new step and renumber existing steps accordingly.
Before:
{
"steps": [
{
"title": "Step 1",
"text": "step1.md"
},
{
"title": "Step 2",
"text": "step2/step2.md"
}
]
}
After:
{
"steps": [
{
"title": "Step 1",
"text": "step1.md"
},
{
"title": "New Step",
"text": "step2/step2.md"
},
{
"title": "Step 2",
"text": "step3/step3.md"
}
]
}
Disclaimer
This is an my personal project to easier create and manage killercoda scenarios. Check out killercoda interactive scenarios to learn more about the service.
License
killercoda-cli
is distributed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for killercoda_cli-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9691d1a4d2ee530a32621caaa84bf0fd1b830452be20366f9044e0c48ada5250 |
|
MD5 | 1fe8ef25e8428718b820157a45745bc6 |
|
BLAKE2b-256 | 2426342fa4e359159a6301fb2c60c44fbcdf3365b7f6054cc898fae4371d4646 |