Merge pull request #7 from AikidoSec/feat/improve-docs-and-validation

Improve readme and update validation of apikey

README.md

@@ -38,6 +38,8 @@ The process will report scan progress and will exit with exitCode `0` if the sca
 
 If you want the scan to run quietly (without output), you can add the `--quiet` option to the command.
 
+Please note that the repository_id which you need to provide to the CLI is the unique ID of the Git provider you are using, not the ID of the repository in Aikido. You can also find this ID in Aikido, by going to the repository's detail page and clicking on the Git provider's icon in the header.
+
 ```sh
 # For more options and combinations, check the help output
 $ aikido-api-client help scan

lib/commands/apiKey.js

@@ -1,8 +1,10 @@
 import { Argument } from 'commander';
 import { setApiKey } from '../configuration.js';
 import { outputError, outputLog } from '../output.js';
+const API_KEY_REGEX = /^AIK_CI_[a-zA-Z0-9]{64}$/g;
 function cli(apiKey) {
-    if (apiKey && apiKey.trim().length != 128) {
+    const isValidApiKey = API_KEY_REGEX.test(apiKey) || apiKey.trim().length === 128;
+    if (apiKey && !isValidApiKey) {
         outputError('That does not seem right, please verify your api key');
     }
     setApiKey(apiKey);

src/commands/apiKey.ts

@@ -2,8 +2,11 @@ import { Argument, Command } from 'commander';
 import { setApiKey } from '../configuration.js';
 import { outputError, outputLog } from '../output.js';
 
+const API_KEY_REGEX = /^AIK_CI_[a-zA-Z0-9]{64}$/g;
+
 function cli(apiKey: string): void {
-  if (apiKey && apiKey.trim().length != 128) {
+  const isValidApiKey = API_KEY_REGEX.test(apiKey) || apiKey.trim().length === 128;
+  if (apiKey && !isValidApiKey) {
     outputError('That does not seem right, please verify your api key');
   }