diff --git a/docs/main/references/cli-commands.md b/docs/main/references/cli-commands.md index fa39572..75c2ac1 100644 --- a/docs/main/references/cli-commands.md +++ b/docs/main/references/cli-commands.md @@ -18,6 +18,7 @@ positional arguments: start Start Xircuits. install Fetch and installs a library for Xircuits. fetch-only Fetch a library for Xircuits. Does not install. + uninstall Uninstall a component library for Xircuits. examples Download examples for Xircuits. compile Compile a Xircuits workflow file. list List available component libraries for Xircuits. @@ -62,6 +63,19 @@ xircuits fetch-only --- +### Uninstall Xircuits Component Library + +```bash +xircuits uninstall +``` + +* Uninstalls a previously installed component library from the `./xai_components/` directory. +* Shows a success message when the library is removed. +* If the library does not exist, a warning will be shown. +* Core libraries such as `xai_utils` and `xai_events` are protected and cannot be uninstalled by default. + +--- + ### Download Xircuits Examples ```bash xircuits examples diff --git a/docs/main/references/xircuits-interface/component-tray.md b/docs/main/references/xircuits-interface/component-tray.md index 38879d3..698f629 100644 --- a/docs/main/references/xircuits-interface/component-tray.md +++ b/docs/main/references/xircuits-interface/component-tray.md @@ -70,6 +70,7 @@ Both local and remote libraries have their own context menus, accessible by clic 2. **See Readme**: Opens the library's README file in a markdown viewer. 3. **Show Example**: Opens an example file for the library. 4. **Open Repository**: Opens the library's repository in a new tab. +5. **Uninstall LIBNAME**: Removes the library from Xircuits after confirmation. Note: The availability of these options depends on the library's configuration in its `pyproject.toml` file. diff --git a/docs/main/references/xircuits-interface/workflow-canvas.md b/docs/main/references/xircuits-interface/workflow-canvas.md index 77081ea..ea91109 100644 --- a/docs/main/references/xircuits-interface/workflow-canvas.md +++ b/docs/main/references/xircuits-interface/workflow-canvas.md @@ -39,11 +39,12 @@ The Xircuits toolbar is displayed on top of every Xircuits canvas. From left to 7. **Lock**: Locks all components in canvas. Locked components cannot be moved, linked-to nor deleted. 8. **Log**: Open Xircuits log window. 9. **Low Power Mode**: Toggle low power mode by disabling link animation. -10. **Reload All Nodes**: Reloads all nodes in the canvas. -11. **Save**: Save current Xircuits canvas. -12. **Compile**: Codegens a Python script based on current canvas. -13. **Save and Run**: Executes the generated Python script on the Python kernel based on Run Options. -13. **Xircuits Run Options** +10. **Toggle Light/Dark Mode**: Switches between light and dark themes. +11. **Reload All Nodes**: Reloads all nodes in the canvas. +12. **Save**: Save current Xircuits canvas. +13. **Compile**: Codegens a Python script based on current canvas. +14. **Save and Run**: Executes the generated Python script on the Python kernel based on Run Options. +15. **Xircuits Run Options** - **Local Run**: Saves, compiles, and executes Xircuits canvas locally. - **Run w/o Compile**: Saves current canvas but does not compile the Python script. Executes Python script with the same filename as the .xircuits file. - **Remote Run**: Saves, compiles, then performs a cmd-based remote run. Used often for Spark Submit. For more information, read [Remote Run](remote-run). @@ -85,7 +86,7 @@ You are able to modify `Parameter Components` (Literal nodes and Argument nodes) There are 2 types of links in Xircuits. - 1. **Flow Links:** They indicate the sequence of a Xircuits workflow. Flow links are blue line flows connecting ▶ ports which will turn solid yellow when highlighted. + 1. **Flow Links:** They indicate the sequence of a Xircuits workflow. Flow links are blue line flows connecting ▶ ports which will turn solid yellow when highlighted. You can drop a flow link anywhere on a target node to auto-connect to its main flow port.
Video

diff --git a/static/img/docs/tray-context-local-component-library.png b/static/img/docs/tray-context-local-component-library.png index 835268b..1959127 100644 Binary files a/static/img/docs/tray-context-local-component-library.png and b/static/img/docs/tray-context-local-component-library.png differ diff --git a/static/img/docs/xircuits-component.png b/static/img/docs/xircuits-component.png index 6a8f5f5..e17445f 100644 Binary files a/static/img/docs/xircuits-component.png and b/static/img/docs/xircuits-component.png differ diff --git a/static/img/docs/xircuits-interface.png b/static/img/docs/xircuits-interface.png index ed25a0b..06270e1 100644 Binary files a/static/img/docs/xircuits-interface.png and b/static/img/docs/xircuits-interface.png differ diff --git a/static/img/docs/xircuits-toolbar.png b/static/img/docs/xircuits-toolbar.png index 9542742..279007f 100644 Binary files a/static/img/docs/xircuits-toolbar.png and b/static/img/docs/xircuits-toolbar.png differ