{"id":21076319,"url":"https://github.com/coderoad/coderoad-cli","last_synced_at":"2025-05-16T06:32:12.073Z","repository":{"id":42117652,"uuid":"266245084","full_name":"coderoad/coderoad-cli","owner":"coderoad","description":"CLI for CodeRoad tutorial creation","archived":false,"fork":false,"pushed_at":"2023-03-04T21:33:03.000Z","size":1388,"stargazers_count":8,"open_issues_count":20,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-06T19:17:31.717Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coderoad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-23T02:04:41.000Z","updated_at":"2024-10-17T04:29:21.000Z","dependencies_parsed_at":"2023-02-15T04:46:04.968Z","dependency_job_id":null,"html_url":"https://github.com/coderoad/coderoad-cli","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderoad%2Fcoderoad-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderoad%2Fcoderoad-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderoad%2Fcoderoad-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderoad%2Fcoderoad-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderoad","download_url":"https://codeload.github.com/coderoad/coderoad-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225413203,"owners_count":17470533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T19:27:50.621Z","updated_at":"2024-11-19T19:27:51.318Z","avatar_url":"https://github.com/coderoad.png","language":"TypeScript","readme":"![Build](https://github.com/coderoad/coderoad-cli/workflows/Build/badge.svg)\n![Publish](https://github.com/coderoad/coderoad-cli/workflows/Publish/badge.svg)\n![NPM](https://img.shields.io/npm/v/@coderoad/cli?color=green\u0026label=npm%3A%40coderoad%2Fcli)\n\n# CodeRoad Buidler - CLI\n\nCommand line interface for [CodeRoad](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad).\n\n## Pre-Requisites\n\n- [NodeJS](https://nodejs.org/)\n- [Git](https://git-scm.com/downloads)\n\n## Install\n\nUse CodeRoad CLI to set up and build a tutorial configuration file.\n\n```shell\nnpm install -g @coderoad/cli\n```\n\n## Create\n\nCreate templates files for building a new tutorial.\n\n```shell\ncoderoad create\n```\n\nTemplates for specific coding languages to come.\n\n## Build\n\nBuild the configuration file to be used by the extension to run the tutorial.\n\n```shell\ncoderoad build\n```\n\nDefaults assume:\n\n- a `TUTORIAL.md` markdown file (change with `--markdown OTHER.md`)\n- a `coderoad.yaml` file (change with `--yaml other.yaml`)\n- an output file of `tutorial.json` (change with `--output other.json`)\n\nThe configuration file is created by matching the `level` and `step` ids between the `TUTORIAL.md` and `coderoad.yaml` files against git commit messages with the same ids. For example:\n\n**TUTORIAL.md**\n\n```markdown\n# Tutorial Title\n\nTutorial description.\n\n## 1. This is a level with id = 1\n\nThis level has two steps...\n\n### 1.1 First step\n\nThe first step with id L1S1. The Step id should start with the level id.\n\n#### HINTS\n\n- The first hint available when a user requests a hint\n- The second hint that will show\n- The third and final hint, as it is last in order\n\n### 1.2 The second step\n\nThe second step...\n```\n\n**coderoad.yaml**\n\n```yaml\n---\nlevels:\n  - id: \"1\"\n    config: {}\n    steps:\n      - id: \"1.1\"\n        setup:\n          files:\n            - package.json\n          commands:\n            - npm install\n        solution:\n          files:\n            - package.json\n          commands:\n            - npm install\n      - id: \"1.2\"\n        setup:\n          files:\n            - src/server.js\n          commands:\n            - npm install\n        solution:\n          files:\n            - src/server.js\n```\n\n... and the commit messages\n\n```text\ncommit 8e0e3a42ae565050181fdb68298114df21467a74 (HEAD -\u003e v2, origin/v2)\nAuthor: creator \u003cauthor@email.com\u003e\nDate:   Sun May 3 16:16:01 2020 -0700\n\n    1.1 some message\n\ncommit 9499611fc9b311040dcabaf2d98439fc0c356cc9\nAuthor: creator \u003cauthor@email.com\u003e\nDate:   Sun May 3 16:13:37 2020 -0700\n\n    1.1S some message\n\ncommit c5c62041282579b495d3589b2eb1fdda2bcd7155\nAuthor: creator \u003cauthor@email.com\u003e\nDate:   Sun May 3 16:11:42 2020 -0700\n\n    1.2 some message\n```\n\nNote that the step `1.1` has two commits, one with the suffix `S`. The first commit refers to the required tests and setup, while the second optional commit contains the solution. If there are multiple commits for a level or step, they are captured in order.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderoad%2Fcoderoad-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderoad%2Fcoderoad-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderoad%2Fcoderoad-cli/lists"}