@intuned/runtime

"use strict";

Object.defineProperty(exports, "__esModule", { value: true }); exports.cliReadme = void 0; const cliReadme = exports.cliReadme = `# Intuned CLI

Introduction

The Intuned CLI exposes a variaty of commands to develop your Intuned projects locally

Development Commands

Initialize a Project

`npx -p @intuned/runtime init`

Run an API

`yarn run-api ` or `npm run run-api `

Options:

• `-i, --parameters-file file-path`: JSON file containing API parameters
• `-s, --store-results`: Store the results in `./output/[runId]/results.json` and `./output/[runId]/extendedPayloads.json`
• `-a, --auth-session `: Name of the auth session instance to use if project is auth-enabled

Build a Project

`yarn cli-build`

Deploy a Project

`yarn deploy ` or `npm run deploy `

• `project-name`: Optional name that overrides the one in intuned.json
• Options:
  • `--workspace-id`: Overrides the workspace ID in intuned.json
  • `--api-key`: Overrides the API key from environment variables

Create an auth session

`yarn create-auth-session ` or `npm create-auth-session `

• `auth-session-name`: Optional name/id of the auth session instance to use, if not provided, a name will be generated with the current timestamp
• Options:
  • `--input`: Auth session input parameters file path

Check an auth session

`yarn check-auth-session ` or `npm check-auth-session `

• `auth-session-name`: Name/id of the auth session instance to check, required

Configuration

Environment Variables and Settings

• `workspaceId`: Your Intuned workspace ID (How to get your workspaceId)
  • Set in `intuned.json` file under the `workspaceId` property
  • Or provide via CLI with `--workspace-id` flag during deployment
• `projectName`: The name of your Intuned project
  • Set in `intuned.json` file under the `projectName` property
  • Or override via command line when deploying with `yarn deploy my-project-name` or `npm run deploy my-project-name`
• `INTUNED_API_KEY`: Your Intuned API key
  • Set as an environment variable: `export INTUNED_API_KEY=your_api_key_here`
  • Or include in your .env file for development
  • Or provide via CLI with `--api-key` flag during deployment

Project Structure

Generated Artifacts

• `./intuned.json`: Project configuration file
• `./api`: Folder containing API implementation files
• `./auth-sessions`: Folder containing auth APIs
• `./parameters`: Folder for API parameters injection
• `./output`: Folder containing generated output files
• `./auth-sessions-instances`: Folder containing auth session instances

Types of auth sessions

• `MANUAL`: Manual auth session, records the session using a recorder and stores it in the `auth-sessions-instances` folder
• `API`: Auth session created via create API, stores the session in the `auth-sessions-instances` folder

Notes

• You can use either `yarn` or `npm run` to execute commands
• All commands must be run from the project root directory
• Verify you're in the correct location by confirming the presence of package.json and intuned.json
• Running commands from subdirectories may result in errors
• You can manage your deployed projects through the Intuned platform
• WARNING: ⚠️ Changes to TS Config may break some Intuned functionalities `;