ciscollm-cli 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ThemeHackers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,112 @@
+# ciscollm-cli
+
+`ciscollm-cli` is a Cisco IOS automation agent CLI for configuration, troubleshooting, and simulation. It supports tool-calling with an LLM, safety guardrails, rollback handling, and a mock switch/router environment for offline testing.
+
+## Installation
+
+Install the published package globally:
+
+```bash
+npm install -g ciscollm-cli
+```
+
+After installation, the `ciscollm` command becomes available in your terminal.
+
+## Quick Start
+
+Show the available commands and flags:
+
+```bash
+ciscollm run --help
+```
+
+Run the agent in mock mode for a safe offline simulation:
+
+```bash
+ciscollm run --protocol mock --goal "Review LAN IP allocation for 192.168.1.0/24"
+```
+
+## What It Does
+
+The CLI takes a user goal, sends it to the selected LLM provider, and lets the agent choose Cisco IOS tool calls step by step.
+
+It can:
+- inspect and modify Cisco-style configuration
+- validate commands with guardrails
+- roll back failed configuration changes
+- simulate interfaces, IP addresses, shell commands, and ping checks in mock mode
+
+## Common Usage
+
+Start a mock session for learning or testing:
+
+```bash
+ciscollm run --protocol mock --goal "Configure 192.168.1.1/24 on LAN A for 25 hosts"
+```
+
+Use a local LLM endpoint:
+
+```bash
+ciscollm run --provider local --local-type lmstudio --endpoint http://127.0.0.1:1234/v1 --protocol mock --goal "Open privileged exec and review IP design"
+```
+
+Use cloud inference with an API key:
+
+```bash
+ciscollm run --provider cloud --api-key YOUR_OPENROUTER_KEY --protocol mock --goal "Check interface status"
+```
+
+Enable strict command-reference enforcement:
+
+```bash
+ciscollm run --strict-command-ref --protocol mock --goal "Review LAN design"
+```
+
+Disable startup telemetry if you want quieter output:
+
+```bash
+ciscollm run --no-ref-telemetry --protocol mock --goal "Review LAN design"
+```
+
+## Command Options
+
+- `--protocol <type>`: Selects the device connection mode. Supported values: `serial`, `ssh`, `telnet`, `mock`.
+- `--provider <type>`: Selects the LLM provider. Supported values: `local`, `cloud`.
+- `--local-type <type>`: Chooses the local LLM server flavor. Supported values: `ollama`, `lmstudio`.
+- `--endpoint <url>`: Sets the LLM API endpoint.
+- `--model <name>`: Sets the model name to use.
+- `--strict-command-ref`: Blocks commands that are not found in the command-reference index.
+- `--no-ref-telemetry`: Turns off command-reference startup telemetry.
+- `--goal <intent>`: Describes the configuration or troubleshooting task.
+
+## Local LLM Notes
+
+If you use a local provider, make sure the endpoint is already running before starting the CLI.
+
+- Ollama usually listens on `http://127.0.0.1:11434/v1`
+- LM Studio usually listens on `http://127.0.0.1:1234/v1`
+
+If the endpoint is unavailable, the CLI will stop early with a clear preflight error.
+
+## Mock Mode
+
+Mock mode is designed for safe offline testing.
+
+It simulates:
+- device connection and prompt modes
+- interface configuration
+- ping behavior
+- command parsing errors
+- shell variable and function behavior
+
+This is the recommended mode when you want to test agent behavior without hardware.
+
+## Troubleshooting
+
+- If you see `ENEEDAUTH`, you are not logged into npm with an account that can publish or access the package.
+- If the CLI says the LLM endpoint is unreachable, start the local server or update `--endpoint`.
+- If a command is blocked in strict mode, it was not matched in the command-reference index.
+
+## Package Name
+
+The package name on npm is `ciscollm-cli`, and it exposes the `ciscollm` executable through the package `bin` entry.

package/dist/cli/ui/ui.d.ts

@@ -0,0 +1,10 @@
+import ora from 'ora';
+export declare const logger: {
+    info: (msg: string) => void;
+    success: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string) => void;
+    critical: (msg: string) => void;
+    heading: (msg: string) => void;
+};
+export declare function createSpinner(text: string): ora.Ora;

package/dist/cli/ui/ui.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+exports.createSpinner = createSpinner;
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+exports.logger = {
+    info: (msg) => console.log(chalk_1.default.blue('ℹ ') + msg),
+    success: (msg) => console.log(chalk_1.default.green('✔ ') + chalk_1.default.bold(msg)),
+    warn: (msg) => console.warn(chalk_1.default.yellow('⚠ ') + chalk_1.default.yellow(msg)),
+    error: (msg) => console.error(chalk_1.default.red('✖ ') + chalk_1.default.red.bold(msg)),
+    critical: (msg) => console.error(chalk_1.default.bgRed.white.bold(' CRITICAL ') + ' ' + chalk_1.default.red(msg)),
+    heading: (msg) => console.log('\n' + chalk_1.default.cyan.bold.underline(msg) + '\n')
+};
+function createSpinner(text) {
+    return (0, ora_1.default)({
+        text,
+        color: 'cyan',
+        spinner: 'dots'
+    });
+}
+//# sourceMappingURL=ui.js.map

package/dist/cli/ui/ui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.js","sourceRoot":"","sources":["../../../src/cli/ui/ui.ts"],"names":[],"mappings":";;;;;;AAYA,sCAMC;AAlBD,kDAA0B;AAC1B,8CAAsB;AAET,QAAA,MAAM,GAAG;IAClB,IAAI,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;IAC1D,OAAO,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1E,IAAI,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC3E,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5E,QAAQ,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,GAAG,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACrG,OAAO,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;CACtF,CAAC;AAEF,SAAgB,aAAa,CAAC,IAAY;IACtC,OAAO,IAAA,aAAG,EAAC;QACP,IAAI;QACJ,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,MAAM;KAClB,CAAC,CAAC;AACP,CAAC"}

package/dist/core/agent/AgentLoop.d.ts

@@ -0,0 +1,38 @@
+import { LLMClient } from '../../infrastructure/llm/LLMClient';
+import { MultiAgentCoordinator } from './MultiAgentCoordinator';
+type AgentLoopOptions = {
+    strictReferenceMode?: boolean;
+    referenceTelemetry?: boolean;
+};
+export declare class CiscoAgentLoop {
+    private llmClient;
+    private coordinator;
+    private messages;
+    private transactions;
+    private firewall;
+    private lastCommandPerDevice;
+    private commandHints;
+    private commandReferenceEngine;
+    private strictReferenceMode;
+    private referenceTelemetry;
+    private options;
+    private validationNudgeCount;
+    constructor(llmClient: LLMClient, coordinator: MultiAgentCoordinator, options?: AgentLoopOptions);
+    private applyOptions;
+    run(userGoal: string): Promise<void>;
+    private triggerAutomaticValidationPing;
+    private resolveValidationDestination;
+    private buildStateInfoString;
+    private findLastMutatedDevice;
+    private resolveTargetDevice;
+    private handleExecuteCommandCall;
+    private handleEnableIosShellCall;
+    private handleDefineShellVariableCall;
+    private handleExecuteShellLoopCall;
+    private handleDefineShellFunctionCall;
+    private handlePingTestCall;
+    private pingFromHost;
+    private injectToolResponse;
+    private truncateOutput;
+}
+export {};