A CLI helper for writing killercoda scenarios and managing steps
Project description
killercoda-cli
Table of Contents
Installation
pip install killercoda-cli
Usage
Pdoc generated Documentation 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.
Functionality:
- Renames and renumbers step files and directories based on user input.
- Updates the 'index.json' file to reflect changes in step order and titles.
Example:
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"
}
]
}
[!NOTE]
The tool automatically handles the renaming of directories and files, ensuring a smooth workflow for scenario development and updates.
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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f72f2c1c40516e9c1519ea2ed9be3a392c7d80cbb018130ea4fa91e6a8eb7ef0 |
|
MD5 | 0c2e9947de00b0a8082fc8aaa0e77cc0 |
|
BLAKE2b-256 | 890760a2fb32ca35c0e87a09d2a4f21a8ff0cf12ca676809671f0c4f4d486c2b |