Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/main/references/cli-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -62,6 +63,19 @@ xircuits fetch-only <component library name>

---

### Uninstall Xircuits Component Library

```bash
xircuits uninstall <component library name>
```

* 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
Expand Down
1 change: 1 addition & 0 deletions docs/main/references/xircuits-interface/component-tray.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
13 changes: 7 additions & 6 deletions docs/main/references/xircuits-interface/workflow-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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.
<details>
<summary>Video</summary>
<p align="center">
Expand Down
Binary file modified static/img/docs/tray-context-local-component-library.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/docs/xircuits-component.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/docs/xircuits-interface.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/docs/xircuits-toolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading