Skip to content

Commit a7fc20a

Browse files
authored
Merge pull request #36 from rabea-al/docs/update-docs
πŸ“„ docs: update CLI uninstall command and UI screenshots
2 parents 8da738a + 9d210b2 commit a7fc20a

File tree

7 files changed

+22
-6
lines changed

7 files changed

+22
-6
lines changed

β€Ždocs/main/references/cli-commands.mdβ€Ž

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ positional arguments:
1818
start Start Xircuits.
1919
install Fetch and installs a library for Xircuits.
2020
fetch-only Fetch a library for Xircuits. Does not install.
21+
uninstall Uninstall a component library for Xircuits.
2122
examples Download examples for Xircuits.
2223
compile Compile a Xircuits workflow file.
2324
list List available component libraries for Xircuits.
@@ -62,6 +63,19 @@ xircuits fetch-only <component library name>
6263

6364
---
6465

66+
### Uninstall Xircuits Component Library
67+
68+
```bash
69+
xircuits uninstall <component library name>
70+
```
71+
72+
* Uninstalls a previously installed component library from the `./xai_components/` directory.
73+
* Shows a success message when the library is removed.
74+
* If the library does not exist, a warning will be shown.
75+
* Core libraries such as `xai_utils` and `xai_events` are protected and cannot be uninstalled by default.
76+
77+
---
78+
6579
### Download Xircuits Examples
6680
```bash
6781
xircuits examples

β€Ždocs/main/references/xircuits-interface/component-tray.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Both local and remote libraries have their own context menus, accessible by clic
7070
2. **See Readme**: Opens the library's README file in a markdown viewer.
7171
3. **Show Example**: Opens an example file for the library.
7272
4. **Open Repository**: Opens the library's repository in a new tab.
73+
5. **Uninstall LIBNAME**: Removes the library from Xircuits after confirmation.
7374

7475
Note: The availability of these options depends on the library's configuration in its `pyproject.toml` file.
7576

β€Ždocs/main/references/xircuits-interface/workflow-canvas.mdβ€Ž

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,12 @@ The Xircuits toolbar is displayed on top of every Xircuits canvas. From left to
3939
7. **Lock**: Locks all components in canvas. Locked components cannot be moved, linked-to nor deleted.
4040
8. **Log**: Open Xircuits log window.
4141
9. **Low Power Mode**: Toggle low power mode by disabling link animation.
42-
10. **Reload All Nodes**: Reloads all nodes in the canvas.
43-
11. **Save**: Save current Xircuits canvas.
44-
12. **Compile**: Codegens a Python script based on current canvas.
45-
13. **Save and Run**: Executes the generated Python script on the Python kernel based on Run Options.
46-
13. **Xircuits Run Options**
42+
10. **Toggle Light/Dark Mode**: Switches between light and dark themes.
43+
11. **Reload All Nodes**: Reloads all nodes in the canvas.
44+
12. **Save**: Save current Xircuits canvas.
45+
13. **Compile**: Codegens a Python script based on current canvas.
46+
14. **Save and Run**: Executes the generated Python script on the Python kernel based on Run Options.
47+
15. **Xircuits Run Options**
4748
- **Local Run**: Saves, compiles, and executes Xircuits canvas locally.
4849
- **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.
4950
- **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)
8586

8687
There are 2 types of links in Xircuits.
8788

88-
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.
89+
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.
8990
<details>
9091
<summary>Video</summary>
9192
<p align="center">
23.4 KB
Loading
35.6 KB
Loading
152 KB
Loading
11.1 KB
Loading

0 commit comments

Comments
Β (0)