Added init command

.gitignore

@@ -102,4 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
-.vitepress/cache/
+
+# VitePress
+cache/

README.md

@@ -97,9 +97,7 @@ As an open-source project, we welcome contributions from the community. If you a
 
 Get support hours covered by SLA, setup and training sessions, prioritized feature requests and bug resolution.
 
-[→ Learn more](https://stepci.com/#pricing)
-
-[→ Schedule a call](https://cal.com/wissmueller/step-ci-enterprise-support)
+<a href="https://cal.com/wissmueller/step-ci-enterprise-support"><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-dark.svg" /></a>
 
 ## Privacy
 
@@ -109,7 +107,7 @@ By default, the CLI collects anonymous usage data, which includes:
 - OS Name
 - Node Version
 - CLI Version
-- Command (`stepci run`, `stepci generate`)
+- Command (`stepci init`, `stepci run`, `stepci generate`)
 - Environment (Local, Docker, CI/CD)
 
 > **Note**: The usage analytics can be disabled by setting `STEPCI_DISABLE_ANALYTICS` environment variable

docs/legal/privacy.md

@@ -6,7 +6,7 @@ By default, the CLI collects anonymous usage data, which includes:
 - OS Name
 - Node Version
 - CLI Version
-- Command (`stepci run`, `stepci generate`)
+- Command (`stepci init`, `stepci run`, `stepci generate`)
 - Environment (Local, Docker, CI/CD)
 
 ::: info

docs/reference/cli.md

@@ -28,6 +28,29 @@ Options:
 
 ## Commands
 
+### `init [path]`
+
+The `init` command lets you init a new workflow
+
+#### **Arguments**
+
+| Argument | Required | Description |
+|-|-|-|
+| path | No | Specify the path to a workflow |
+
+#### **Examples**
+
+Initialise a workflow
+
+```
+stepci init
+```
+
+```
+Success! The workflow file can be found at workflow.yml
+Enter npx stepci run workflow.yml to run it
+```
+
 ### `run [workflow]`
 
 The `run` command lets you run a specified workflow

package.json

@@ -1,6 +1,6 @@
 {
   "name": "stepci",
-  "version": "2.6.9",
+  "version": "2.7.0",
   "description": "API Testing and Monitoring made simple",
   "main": "index.js",
   "bin": {
@@ -34,6 +34,7 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "build:watch": "tsc -w -p tsconfig.json",
+    "init": "ts-node ./src/index.ts init",
     "test": "ts-node ./src/index.ts run",
     "test:generate": "ts-node ./src/index.ts generate",
     "test:loadtest": "ts-node ./src/index.ts run --loadtest",

src/index.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
+import fs from 'fs'
 import { runFromFile, TestResult, WorkflowResult } from '@stepci/runner'
 import { loadTestFromFile }  from '@stepci/runner/dist/loadtesting'
 import { generateWorkflowFile, GenerateWorkflowOptions } from '@stepci/plugin-openapi'
@@ -148,6 +149,32 @@ yargs(hideBin(process.argv))
     console.log(`${chalk.greenBright('Success!')} The workflow file can be found at ${argv.path}`)
     renderFeedbackMessage()
   })
+  .command('init', 'Init a Step CI workflow', yargs => {
+    return yargs
+      .positional('path', {
+        describe: 'workflow file path',
+        type: 'string',
+        default: 'workflow.yml'
+      })
+    },
+  (argv) => {
+    const defaultWorkflow = `version: "1.1"
+name: Status Check
+env:
+  host: example.com
+tests:
+  example:
+    steps:
+      - name: GET request
+        http:
+          url: https://\${{env.host}}
+          method: GET
+          check:
+            status: /^20/`
+
+    fs.writeFileSync(argv.path, defaultWorkflow)
+    console.log(`${chalk.greenBright('Success!')} The workflow file can be found at ${argv.path}\nEnter ${chalk.grey('npx stepci run ' + argv.path)} to run it`)
+  })
   .command(['$0'], false, () => {}, () => console.log(defaultText))
   .parse()