citadel_cli 1.1.0 → 1.1.3

package/README.md

@@ -1,15 +1,15 @@
 # Citadel CLI
 
-A hierarchical command-line interface (CLI) for web applications.
+Citadel CLI enhances React applications by adding a keyboard-driven command line component to your application, allowing rapid task execution for power users and developers.
 
-Use cases:
+## Use Cases
 
-- Developers: Perform (multiple) REST API calls & view results, view/modify
-  cookies/localstorage. Do JavaScript things without affecting the application.
-- "Poor man's Postman": execute API calls within the context of your application
-- Devops: Improve how you interface with your existing CI/CD web app
-- Power users: Provide a hook for advanced users of your internal or external
-  applications to quickly perform complex actions
+- **API Testing & Debugging**: Execute REST calls, inspect responses, and manipulate cookies/localStorage without leaving your
+application context
+- **Power User Workflows**: Transform repetitive click-through sequences into fast keyboard commands for advanced users
+- **DevOps Integration**: Add command-line control to CI/CD dashboards and deployment tools for rapid operations
+- **Internal Tool Enhancement**: Give your team's web applications the speed and efficiency of terminal interfaces
+- Perform (multiple) REST API calls & view results, view/modify cookies/localstorage. Do JavaScript things without affecting the application.
 
 ![Animated screenshot of Citadel CLI](https://github.com/user-attachments/assets/b64da0f7-a4a0-4f76-bc03-c0e40c0e14e5)
 
@@ -44,20 +44,18 @@ following:
 
 ![screenshot_help_cmd](https://github.com/user-attachments/assets/1cc6fd58-7591-45f1-980a-46da15a1843a)
 
-When you execute a command the result is displayed in the output area. It shows
-the command that was executed, a timestamp, whether the command succesfully
-executed, and the command's output.
+## Adding Commands
 
-Adding your own commands is pretty straightforward. There are three steps to doing so.
+To add your own commands:
 
-1. Create a `CommandRegistry`
-2. Add commands to the registry
+1. Create a `CommandRegistry` object
+2. Add commands to the registry object via the `addCommand` function
 3. Pass the registry to the `Citadel` component
 
-Let's add a simple `greet` command to demonstrate this. 
+For example, let's add a simple `greet` command. 
 
 ```
-import { CommandRegistry, TextCommandResult } from "citadel_cli";
+import { Citadel, CommandRegistry, TextCommandResult } from "citadel_cli";
 
 // 1. Create the registry where your commands will be stored
 const cmdRegistry = new CommandRegistry();
@@ -224,8 +222,8 @@ npm link
 
 5. (Optional) From the directory of the project you want to import Citadel into:
 ```bash
-npm link @jchilders/citadel_cli
-# ... your normal build/run steps ...
+npm unlink citadel_cli && npm link citadel_cli
+# ... your normal dev process ...
 ```
 
 Load your appliation and press <kbd>.</kbd>
@@ -254,7 +252,7 @@ Load your appliation and press <kbd>.</kbd>
 4. Write or update tests as needed
 5. Run the test suite to ensure everything passes:
    ```bash
-   npm test
+   npm run test
    ```
 6. Commit your changes with a clear and descriptive commit message
 7. Push to your fork and submit a pull request

package/dist/App.d.ts

@@ -0,0 +1,2 @@
+declare function App(): import("react/jsx-runtime").JSX.Element;
+export default App;

package/dist/citadel.css

@@ -1 +1 @@
-._container_141sr_3{position:fixed;height:var(--citadel-default-height);min-height:var(--citadel-min-height);max-height:var(--citadel-max-height);background-color:var(--citadel-bg);overflow:hidden;width:100%;box-sizing:border-box;margin:0;padding:0;bottom:0;left:0;right:0}._innerContainer_141sr_19{height:100%;width:100%;display:flex;flex-direction:column;margin:0;padding:0}._inputSection_141sr_28{border-top:1px solid var(--citadel-border);padding:1rem;margin:0;box-sizing:border-box}._resizeHandle_141sr_35{width:100%;height:6px;background:transparent;cursor:ns-resize;position:absolute;top:-3px;left:0;right:0;z-index:10;-moz-user-select:none;user-select:none;-webkit-user-select:none;pointer-events:all}._resizeHandle_141sr_35:hover{background:#ffffff1a}@keyframes _citadel_slideUp_141sr_64{0%{transform:translateY(100%)}to{transform:translateY(0)}}@keyframes _citadel_slideDown_141sr_68{0%{transform:translateY(0)}to{transform:translateY(100%)}}._citadel_slideUp_141sr_64{animation:_citadel_slideUp_141sr_64 .2s ease-out forwards}._citadel_slideDown_141sr_68{animation:_citadel_slideDown_141sr_68 .2s ease-out forwards}@keyframes _shake_e9b9w_1{0%,to{transform:translate(0)}25%{transform:translate(-4px)}75%{transform:translate(4px)}}@keyframes _flashBorder_e9b9w_1{0%,to{border-color:transparent}50%{border-color:#ef4444}}._invalidInput_e9b9w_12{animation:_shake_e9b9w_1 .2s ease-in-out,_flashBorder_e9b9w_1 .3s ease-in-out;border-width:1px;border-style:solid}
+._container_141sr_3{position:fixed;height:var(--citadel-default-height);min-height:var(--citadel-min-height);max-height:var(--citadel-max-height);background-color:var(--citadel-bg);overflow:hidden;width:100%;box-sizing:border-box;margin:0;padding:0;bottom:0;left:0;right:0}._innerContainer_141sr_19{height:100%;width:100%;display:flex;flex-direction:column;margin:0;padding:0}._inputSection_141sr_28{border-top:1px solid var(--citadel-border);padding:1rem;margin:0;box-sizing:border-box}._resizeHandle_141sr_35{width:100%;height:6px;background:transparent;cursor:ns-resize;position:absolute;top:-3px;left:0;right:0;z-index:10;-moz-user-select:none;user-select:none;-webkit-user-select:none;pointer-events:all}._resizeHandle_141sr_35:hover{background:#ffffff1a}@keyframes _citadel_slideUp_141sr_64{0%{transform:translateY(100%)}to{transform:translateY(0)}}@keyframes _citadel_slideDown_141sr_68{0%{transform:translateY(0)}to{transform:translateY(100%)}}._citadel_slideUp_141sr_64{animation:_citadel_slideUp_141sr_64 .2s ease-out forwards}._citadel_slideDown_141sr_68{animation:_citadel_slideDown_141sr_68 .2s ease-out forwards}