initial commit

Author: RobAirbotics

.gitignore

@@ -0,0 +1,17 @@
+**/.DS_Store
+*-debug.log
+*-error.log
+/.idea
+/.nyc_output
+/dist
+/lib
+/package-lock.json
+/tmp
+/yarn.lock
+node_modules
+oclif.manifest.json
+.editorconfig
+.eslintignore
+.eslintrc
+.mocharc.json
+.vscode/

README.md

@@ -0,0 +1,46 @@
+Example CLI
+=================
+
+This repo contains the source code for the [Build a custom CLI](https://docs.airbotics.io/guides/cli) guide in the Airbotics documentation.
+
+
+## Prerequisites
+1. [Node.js](https://nodejs.org/) installed.
+2. An Airbotics account with:
+    - At least 1 robot created.
+    - At least 1 API key created.
+3. Set the `AIR_API_KEY` with  a valid API key.
+
+## Installation
+```
+npm i
+npm run build
+npm link
+export API_KEY="<your_api_key>"
+```
+
+## Usage
+```
+acme [COMMAND]
+```
+
+
+## Implemented commands
+
+```
+# Print a list of robots with:
+acme robots list
+
+# Configure logs for a robot with:
+acme robots config-logs --enabled=true --robot_id=dev_bot_1
+
+# Print a list of airbotics commands:
+acme commands list 
+```
+
+## Uninstall
+```
+npm unlink -g
+```
+
+

bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package.json

@@ -0,0 +1,82 @@
+{
+  "name": "acme",
+  "version": "0.0.0",
+  "description": "oclif example Hello World CLI",
+  "author": " @RobAirbotics",
+  "bin": {
+    "acme": "./bin/run"
+  },
+  "homepage": "https://github.com/RobAirbotics/acme",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": "RobAirbotics/acme",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^3.2.0",
+    "axios": "^1.4.0"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2.4.4",
+    "@types/chai": "^4",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.18.40",
+    "chai": "^4",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.3",
+    "mocha": "^9",
+    "oclif": "^3.11.3",
+    "shx": "^0.3.3",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.6.1",
+    "typescript": "^4.9.5"
+  },
+  "oclif": {
+    "bin": "acme",
+    "dirname": "acme",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "robots": {
+        "description": "Robot operations"
+      },
+      "list": {
+        "description": "List resources"
+      },
+      "config": {
+        "description": "Configure resources"
+      }
+    },
+    "hooks": {
+      "prerun": "./dist/hooks/prerun/key_check"
+    }
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "npm run build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "bugs": "https://github.com/RobAirbotics/acme/issues",
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts"
+}

src/commands/commands/list.ts

@@ -0,0 +1,21 @@
+import { Args, Command, Flags } from '@oclif/core'
+import axios from 'axios';
+
+export default class CommandsList extends Command {
+
+  static description = 'list your commands'
+
+  public async run(): Promise<void> {
+    try {
+      const apiKey = process.env.AIR_API_KEY;
+      const authHeader = { 'air-api-key': apiKey};
+      const response = await axios.get('https://api.airbotics.io/commands', { 'headers': authHeader })
+      this.log(response.data);
+    } catch (e) {
+      this.log('unable to get a list of robots');
+      this.log(e as string)
+      this.exit(1);
+    }
+  }
+
+}

src/commands/robots/config-logs.ts

@@ -0,0 +1,33 @@
+import { Args, Command, Flags } from '@oclif/core';
+import axios from 'axios';
+
+export default class ConfigLogs extends Command {
+  
+  static description = 'configure logs on a robot';
+
+  static flags = {
+    enabled: Flags.string({char: 'e', description: 'enable logs', required: true, options: ['true', 'false']}),
+    robot_id: Flags.string({char: 'r', description: 'robot id', required: true})
+  }
+
+  public async run(): Promise<void> {
+
+    const { flags}  = await this.parse(ConfigLogs);
+
+    const enabled: boolean = flags.enabled === 'true' ? true: false;
+    const robotId: string = flags.robot_id
+   
+    try {
+      const apiKey = process.env.AIR_API_KEY;
+      const authHeader = { 'air-api-key': apiKey };
+      const url = `https://api.airbotics.io/robots/${robotId}/logs/config`;
+      const body = { enabled: enabled };
+      const response = await axios.patch(url, body, { 'headers': authHeader });
+      this.log(response.data);
+    } catch (e) {
+      this.log('unable to configure logs for robot');
+      this.exit(1);
+    }
+  }
+  
+}

src/commands/robots/list.ts

@@ -0,0 +1,21 @@
+import { Args, Command, Flags } from '@oclif/core'
+import axios from 'axios';
+
+export default class RobotsList extends Command {
+
+  static description = 'list your robots'
+
+  public async run(): Promise<void> {
+    try {
+      const apiKey = process.env.AIR_API_KEY;
+      const authHeader = { 'air-api-key': apiKey};
+      const response = await axios.get('https://api.airbotics.io/robots', { 'headers': authHeader })
+      this.log(response.data);
+    } catch (e) {
+      this.log('unable to get a list of robots');
+      this.log(e as string)
+      this.exit(1);
+    }
+  }
+
+}

src/hooks/prerun/key_check.ts

@@ -0,0 +1,8 @@
+import {Hook} from '@oclif/core'
+
+export const hook: Hook<'prerun'> = async function (opts) {
+  if(process.env.AIR_API_KEY === undefined) {
+    process.stderr.write('AIR_API_KEY was not found\n')
+    process.exit(1);
+  }
+}

src/index.ts

@@ -0,0 +1 @@
+export {run} from '@oclif/core'

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "importHelpers": true,
+    "module": "commonjs",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "target": "es2019"
+  },
+  "include": [
+    "src/**/*"
+  ]
+}