### Install OpenClaw Plug-in Example Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openclaw-skills.md Example of installing the BlueBubbles plug-in. Ensure you use the correct name as listed by the 'openclaw plugins list' command. ```bash openclaw plugins install @openclaw/bluebubbles ``` -------------------------------- ### Start OpenClaw Onboarding Wizard Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openclaw.md Initiate the OpenClaw setup process using the interactive CLI wizard. This command guides you through configuration steps. ```bash openclaw onboard ``` -------------------------------- ### Autofill Setup Tabs Source: https://github.com/beclab/olares/wiki/Markdown-reference Organize platform-specific instructions using tabs. This example shows autofill setup for Android, iOS, and the Chrome extension. ```markdown ``` -------------------------------- ### Start and Configure LXC Container Source: https://github.com/beclab/olares/blob/main/docs/manual/get-started/install-lxc.md Commands to start the LXC container, enter it for initial setup, create necessary directories, and update the PATH environment variable. ```bash # Start the container pct start 16553 # Enter the container pct enter 16553 # Create missing directories mkdir -p /lib/modules # Update PATH environment variable echo 'export PATH="/usr/local/bin:$PATH"' >> /root/.bashrc source ~/.bashrc # exit LXC exit ``` -------------------------------- ### Install Plugins via npm Source: https://github.com/beclab/olares/blob/main/docs/use-cases/opencode-extensions.md Declare plugins in the OpenCode configuration file to have them installed automatically on startup. This example shows global configuration. ```json { "$schema": "https://opencode.ai/config.json", "plugin": [ "opencode-helicone-session", "opencode-wakatime" ] } ``` -------------------------------- ### Local Development CLI Setup Source: https://github.com/beclab/olares/blob/main/cli/README.md Installs the locally built CLI binary and skills from the current checkout. Requires Go 1.24+ and a full repository clone. ```bash cd cli sudo make install # or: make install PREFIX="$HOME/.local" npx skills add "$(pwd)/skills" --skill '*' -a cursor -g -y # install the local checkout's skills make uninstall # remove the binary again ``` -------------------------------- ### Run NVIDIA Driver Installer Source: https://github.com/beclab/olares/blob/main/docs/manual/best-practices/install-specific-cuda-version.md Execute the NVIDIA driver runfile with root privileges to start the installation. Follow the on-screen prompts. ```bash sudo ./NVIDIA-Linux-x86_64-580.95.05.run ``` -------------------------------- ### Install and Suggest Skills in Context7 Terminal Source: https://context7.com/beclab/olares/llms.txt These bash commands demonstrate how to install a specific skill from a repository and how to get skill suggestions based on your current project context. ```bash # Install a specific skill ctx7 skills install /anthropics/skills pdf ``` ```bash # Get skill suggestions based on your project ctx7 skills suggest ``` -------------------------------- ### Install Olares with Custom Domain Preparation Source: https://github.com/beclab/olares/blob/main/docs/reusables/custom-domain.md Run this command to perform the initial Olares installation, preparing the system for custom domain setup. Ensure your device is on the same network as your phone. ```bash export PREINSTALL=1 && curl -sSfL https://olares.sh | bash - ``` -------------------------------- ### Olares Installation Completion Summary Source: https://github.com/beclab/olares/blob/main/docs/developer/install/installation-process.md This output provides the final installation summary, including the URL for the activation wizard and the initial login credentials. Use these details to complete the Olares setup in your browser. ```bash 2024-12-17T21:00:58.086+0800 [INFO] Installation wizard is complete 2024-12-17T21:00:58.086+0800 [INFO] All done ------------------------------------------------ 2024-12-17T21:00:58.086+0800 Olares is running at: 2024-12-17T21:00:58.086+0800 http://192.168.1.16:30180 2024-12-17T21:00:58.086+0800 Open your browser and visit the above address 2024-12-17T21:00:58.086+0800 with the following credentials: 2024-12-17T21:00:58.086+0800 Username: marvin113 2024-12-17T21:00:58.086+0800 Password: 2uO5PZ2X ``` -------------------------------- ### Start Hermes Agent Setup Wizard Source: https://github.com/beclab/olares/blob/main/docs/use-cases/hermes.md Execute this command in the Hermes CLI to initiate the configuration wizard for connecting to a local model. ```bash hermes setup ``` -------------------------------- ### Start OpenClaw Channel Configuration Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openclaw-integration.md Use this command to initiate the OpenClaw configuration wizard for channel setup. ```bash openclaw configure --section channels ``` -------------------------------- ### Start OpenClaw Configuration Wizard Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openclaw-skills.md Use this command to launch the interactive wizard for configuring OpenClaw, including installing skills. ```bash openclaw config ``` -------------------------------- ### Install Go Package Source: https://github.com/beclab/olares/blob/main/docs/use-cases/claude-code.md Install Go packages using the go install command. Packages are typically installed to the ~/go/bin directory. ```bash go install @latest ``` -------------------------------- ### Full xorg.conf Example Source: https://github.com/beclab/olares/blob/main/docs/use-cases/play-games-directly.md A comprehensive `xorg.conf` configuration including ServerLayout, Monitor, Device, Screen, and ServerFlags sections. This provides a reference for setting up physical monitors and NVIDIA drivers. ```bash Section "ServerLayout" Identifier "Default Layout" Screen 0 "Default Screen" EndSection Section "Monitor" Modeline "1920x1080R" 138.50 1920 1968 2000 2080 1080 1083 1088 1111 +hsync -vsync Identifier "Configured Monitor" HorizSync 5.0 - 1000.0 VertRefresh 5.0 - 200.0 ModeLine "1920x1080" 148.50 1920 2448 2492 2640 1080 1084 1089 1125 +hsync +vsync EndSection Section "Device" Identifier "Configured Video Device" Driver "nvidia" Option "ModeValidation" "NoMaxPClkCheck, NoEdidMaxPClkCheck, NoMaxSizeCheck, NoHorizSyncCheck, NoVertRefreshCheck, NoVirtualSizeCheck, NoTotalSizeCheck, NoDualLinkDVICheck, NoDisplayPortBandwidthCheck, AllowNon3DVisionModes, AllowNonHDMI3DModes, AllowNonEdidModes, NoEdidHDMI2Check, AllowDpInterlaced" Option "AllowEmptyInitialConfiguration" Option "PrimaryGPU" "yes" Option "AllowExternalGpus" "True" BusID "PCI:1:0:0" EndSection Section "Screen" Identifier "Default Screen" Device "Configured Video Device" Monitor "Configured Monitor" DefaultDepth 24 Option "ProbeAllGpus" "False" Option "BaseMosaic" "False" Option "AllowEmptyInitialConfiguration" "True" Option "ConnectedMonitor" "DFP" SubSection "Display" Virtual 1920 1080 Depth 24 Modes "1920x1080R" "1920x1080" "1280x800" "1024x768" "1920x1080" "1600x900" "1440x900" EndSubSection EndSection Section "ServerFlags" Option "AutoAddGPU" "false" EndSection ``` -------------------------------- ### Set Up Container Runtime Source: https://github.com/beclab/olares/blob/main/docs/developer/install/installation-process.md This output details the installation and startup of the container runtime, including containerd and related services, and importing container images. ```bash 2024-12-17T19:47:37.510+0800 [Module] InstallContainerModule(k3s) 2024-12-17T19:47:37.518+0800 [A] ubuntu: ZfsMountReset skipped (7.321811ms) 2024-12-17T19:47:37.525+0800 [A] ubuntu: CreateZfsMount skipped (7.322591ms) 2024-12-17T19:47:38.188+0800 [A] ubuntu: SyncContainerd success (662.643982ms) 2024-12-17T19:47:38.368+0800 [A] ubuntu: SyncCrictlBinaries success (179.758334ms) 2024-12-17T19:47:38.399+0800 [A] ubuntu: GenerateContainerdService success (31.410118ms) 2024-12-17T19:47:38.451+0800 [A] ubuntu: GenerateContainerdConfig success (52.047108ms) 2024-12-17T19:47:38.505+0800 [A] ubuntu: GenerateCrictlConfig success (53.760209ms) 2024-12-17T19:47:38.857+0800 [A] ubuntu: EnableContainerd success (352.128078ms) 2024-12-17T19:47:38.857+0800 [Module] PreloadImages 2024-12-17T19:47:41.665+0800 (1/145) imported image: rancher/mirrored-pause:3.6, time: 194.363948ms ... ``` -------------------------------- ### Install 'gh' Dependency using npm Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openclaw-skills.md Example command to install a specific dependency, 'gh', for the 'gh-issues' skill using npm. Ensure you have npm installed and configured. ```bash npm i -g gh ``` -------------------------------- ### Olares Installation Success Output Source: https://github.com/beclab/olares/blob/main/docs/manual/get-started/install-pve-iso.md This is an example of the expected output when the 'olares-check' command confirms a successful Olares installation on PVE. ```bash ... check Olaresd: success check Containerd: success ``` -------------------------------- ### Example: Temporarily mount a partition Source: https://github.com/beclab/olares/blob/main/docs/manual/best-practices/expand-storage-in-olares.md An example demonstrating how to mount the partition `/dev/nvme1n1p1` to the directory `/olares/share/hdd0`. This is useful for immediate access to the drive's contents. ```bash sudo mount /dev/nvme1n1p1 /olares/share/hdd0 ``` -------------------------------- ### Search Installed Applications Source: https://github.com/beclab/olares/blob/main/cli/skills/olares-search/SKILL.md Search for installed applications. Examples include a general search and a specific application search with JSON output. ```bash # Search installed applications. olares-cli search app wise ``` ```bash olares-cli search app firefox -o json ``` -------------------------------- ### Manually Install NVIDIA Drivers Source: https://github.com/beclab/olares/blob/main/docs/manual/help/installation.md Use this command to manually trigger NVIDIA driver installation if the automatic setup fails due to conflicts with previously installed drivers. Reboot the machine before running this command. Verify the installation with `nvidia-smi`. ```bash olares-cli gpu install ``` ```bash nvidia-smi ``` -------------------------------- ### Start Development Server Source: https://github.com/beclab/olares/blob/main/docs/README.md Starts a local development server with hot-reloading for live preview of documentation changes. Access the preview at http://localhost:5173/. ```bash npm run dev ``` -------------------------------- ### Setup Pool CLI Source: https://github.com/beclab/olares/blob/main/docs/use-cases/pool-cli.md Run this command to initiate the setup process for the Pool CLI, which includes authentication with the Poolside cloud service. ```bash pool setup ``` -------------------------------- ### Install and Watch an Application Source: https://github.com/beclab/olares/blob/main/cli/skills/olares-market/references/olares-market-watch.md Use this command to install an application and monitor its progress without blocking. If the initial watch times out, switch to polling the status. ```bash market install X --watch --watch-timeout 1m -o json ``` ```bash market status X --watch --watch-interval 5s ``` -------------------------------- ### Setup Hermes Gateway for Discord Source: https://github.com/beclab/olares/blob/main/docs/use-cases/hermes.md Initiate the configuration wizard for the Hermes gateway to connect with a messaging platform. This command starts an interactive setup process. ```bash hermes gateway setup ``` -------------------------------- ### Start Quadruped Locomotion Demo (AMD64 with WebRTC) Source: https://github.com/beclab/olares/blob/main/docs/use-cases/isaac-lab.md Use this command on an AMD64 Olares host to start the quadruped locomotion demo with WebRTC streaming enabled. The workload runs in the background. ```bash LIVESTREAM=1 nohup ./isaaclab.sh -p scripts/demos/quadrupeds.py --headless & ``` -------------------------------- ### Install Custom Node via GitHub URL Source: https://github.com/beclab/olares/blob/main/docs/use-cases/comfyui-for-krita.md This is an example of a GitHub URL used to install a custom node for ComfyUI through its launcher. Repeat this process for all required nodes. ```plaintext https://github.com/Acly/comfyui-tooling-nodes ``` -------------------------------- ### Install an app Source: https://github.com/beclab/olares/blob/main/docs/use-cases/nemoclaw-olares-cli.md Use natural language to install an application from the Olares Market. ```text Install Firefox ``` -------------------------------- ### Initialize OpenCode Source: https://github.com/beclab/olares/blob/main/docs/use-cases/opencode.md Initializes OpenCode and creates its configuration file at ~/.config/opencode/opencode.jsonc. This command should be run after installation. ```bash opencode ``` -------------------------------- ### Create User and Watch for Login Readiness Source: https://github.com/beclab/olares/blob/main/cli/skills/olares-settings/references/olares-settings-users.md Use this command to create a user with default settings and monitor their readiness for login. The output is piped to jq to extract the wizard URL. ```bash users create --defaults --watch -o json | jq '.wizard_url' ``` -------------------------------- ### App Scope Configuration for Shared Apps Source: https://github.com/beclab/olares/blob/main/docs/developer/develop/package/manifest.md Configure application scope for shared apps. Set `clusterScoped` to `true` and provide `appRef` for cluster-wide installation. This example shows conditional logic for administrator installation. ```yaml metadata: name: ollamav2 options: appScope: {{- if and .Values.admin .Values.bfl.username (eq .Values.admin .Values.bfl.username) }} # Only the administrator installs the shared service clusterScoped: true appRef: - ollamav2 # the name of current app specified in metadata.name {{- else }} clusterScoped: false {{- end }} dependencies: - name: olares version: '>=1.12.3-0' type: system {{- if and .Values.admin .Values.bfl.username (eq .Values.admin .Values.bfl.username) }} {{- else }} type: application version: '>=1.0.1' mandatory: true # Other users install the client, depend on the shared service installed by the admin {{- end }} ``` -------------------------------- ### Check Current CUDA and Driver Version Source: https://github.com/beclab/olares/blob/main/docs/manual/best-practices/install-specific-cuda-version.md Run this command on the Olares host to display the currently installed NVIDIA driver and CUDA toolkit versions. This helps in identifying the existing setup before proceeding with an installation. ```bash nvidia-smi ``` -------------------------------- ### Kubernetes Deployment Script Output Source: https://github.com/beclab/olares/blob/main/docs/developer/install/installation-process.md This output details the steps involved in deploying Kubernetes, including certificate generation, etcd setup, K3s installation, and service enablement. It shows the progress and success of each module during the installation. ```bash [certs] Generating "ca" certificate and key [certs] admin-ubuntu serving cert is signed for DNS names [etcd etcd.kube-system etcd.kube-system.svc etcd.kube-system.svc.cluster.local lb.kubesphere.local localhost ubuntu] and IPs [127.0.0.1 ::1 192.168.1.16] [certs] member-ubuntu serving cert is signed for DNS names [etcd etcd.kube-system etcd.kube-system.svc etcd.kube-system.svc.cluster.local lb.kubesphere.local localhost ubuntu] and IPs [127.0.0.1 ::1 192.168.1.16] [certs] node-ubuntu serving cert is signed for DNS names [etcd etcd.kube-system etcd.kube-system.svc etcd.kube-system.svc.cluster.local lb.kubesphere.local localhost ubuntu] and IPs [127.0.0.1 ::1 192.168.1.16] 2024-12-17T19:52:36.957+0800 [A] LocalHost: GenerateETCDCerts success (263.237575ms) 2024-12-17T19:52:37.263+0800 [A] ubuntu: SyncCertsFile success (306.213676ms) 2024-12-17T19:52:37.264+0800 [A] ubuntu: SyncCertsFileToMaster skipped (20.351µs) 2024-12-17T19:52:37.264+0800 [Module] InstallETCDBinaryModule 2024-12-17T19:52:37.698+0800 [A] ubuntu: InstallETCDBinary success (434.014395ms) 2024-12-17T19:52:37.728+0800 [A] ubuntu: GenerateETCDService success (30.732882ms) 2024-12-17T19:52:37.728+0800 [A] ubuntu: GenerateAccessAddress success (23.491µs) 2024-12-17T19:52:37.728+0800 [Module] ETCDConfigureModule 2024-12-17T19:52:37.728+0800 [A] ubuntu: ExistETCDHealthCheck skipped (9.903µs) 2024-12-17T19:52:37.753+0800 [A] ubuntu: GenerateETCDConfig success (24.125665ms) 2024-12-17T19:52:37.773+0800 [A] ubuntu: AllRefreshETCDConfig success (20.321235ms) 2024-12-17T19:52:40.048+0800 [A] ubuntu: RestartETCD success (2.274541565s) 2024-12-17T19:52:40.068+0800 [A] ubuntu: AllETCDNodeHealthCheck success (20.251062ms) 2024-12-17T19:52:40.094+0800 [A] ubuntu: RefreshETCDConfigToExist success (26.207599ms) 2024-12-17T19:52:40.129+0800 [A] ubuntu: AllETCDNodeHealthCheck success (34.462881ms) 2024-12-17T19:52:40.129+0800 [Module] ETCDBackupModule 2024-12-17T19:52:40.185+0800 [A] ubuntu: BackupETCD success (56.639923ms) 2024-12-17T19:52:40.230+0800 [A] ubuntu: GenerateBackupETCDService success (44.727929ms) 2024-12-17T19:52:40.273+0800 [A] ubuntu: GenerateBackupETCDTimer success (42.839457ms) 2024-12-17T19:52:40.396+0800 [A] ubuntu: EnableBackupETCDService success (122.621074ms) 2024-12-17T19:52:40.396+0800 [Module] InstallKubeBinariesModule 2024-12-17T19:52:41.188+0800 [A] ubuntu: SyncKubeBinary(k3s) success (791.866964ms) 2024-12-17T19:52:41.218+0800 [A] ubuntu: GenerateK3sKillAllScript success (30.442837ms) 2024-12-17T19:52:41.253+0800 [A] ubuntu: GenerateK3sUninstallScript success (34.802683ms) 2024-12-17T19:52:41.268+0800 [A] ubuntu: ChmodScript(k3s) success (14.640733ms) 2024-12-17T19:52:41.268+0800 [Module] K3sInitClusterModule 2024-12-17T19:52:41.334+0800 [A] ubuntu: GenerateK3sService success (66.556896ms) 2024-12-17T19:52:41.379+0800 [A] ubuntu: GenerateK3sServiceEnv success (44.492752ms) 2024-12-17T19:52:41.414+0800 [A] ubuntu: GenerateK3sRegistryConfig success (34.814475ms) 2024-12-17T19:52:46.511+0800 [A] ubuntu: EnableK3sService success (5.097800474s) 2024-12-17T19:52:46.572+0800 [A] ubuntu: CopyKubeConfig success (60.33887ms) ... ``` -------------------------------- ### Example Docker PS Output Source: https://github.com/beclab/olares/blob/main/docs/manual/get-started/install-linux-docker.md This output shows the running Olares containers and their port mappings after a successful installation. ```bash CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 28e86c473750 beclab/olaresd:proxy-v0.1.0 "/mdns-agent" About a minute ago Up About a minute olares-olaresd-proxy-1 5fd68a8709ad beclab/olares:1.11.5 "/usr/local/bin/entr…" 2 minutes ago Up About a minute 0.0.0.0:80->80/tcp... olares-olares-1 ``` -------------------------------- ### Retrieve Olares Installation Password from Log Source: https://github.com/beclab/olares/blob/main/docs/manual/help/installation.md If the Olares installation times out without displaying the password, retrieve it from the installation log file. This often happens due to insufficient system resources in a VM. Replace `v1.12.2` with your Olares version. After retrieving the password, check service status with `kubectl get pod -A`. ```bash # Replace v1.12.2 with your specific Olares version number. grep password $HOME/.olares/versions/v1.12.2/logs/install.log ``` ```bash kubectl get pod -A ``` -------------------------------- ### Start Quadruped Locomotion Demo (ARM64) Source: https://github.com/beclab/olares/blob/main/docs/use-cases/isaac-lab.md Use this command on an ARM64 Olares host to start the quadruped locomotion demo. WebRTC streaming is not supported on ARM64 hosts. ```bash nohup ./isaaclab.sh -p scripts/demos/quadrupeds.py & ``` -------------------------------- ### Upload and Install a Custom Chart Source: https://github.com/beclab/olares/blob/main/cli/skills/olares-market/references/olares-market-watch.md First, upload a custom chart archive. Then, install the chart by referencing its name and specifying the 'upload' source. ```bash market upload ./mychart.tgz ``` ```bash market install -s upload ``` -------------------------------- ### List Available Skills Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openclaw-skills.md Run this command to display a list of all officially preset skills available for installation. ```bash openclaw skills list ``` -------------------------------- ### Regenerate Subscription Configuration Source: https://github.com/beclab/olares/blob/main/docs/use-cases/opencode-omo.md Use the `npx oh-my-opencode install` command with flags to regenerate `oh-my-openagent.json` based on your subscriptions. This example enables Claude and Copilot. ```text Run: npx oh-my-opencode install --no-tui --claude=yes --openai=no --gemini=no --copilot=yes ``` -------------------------------- ### View GPU status Source: https://github.com/beclab/olares/blob/main/docs/developer/install/cli/gpu.md Displays the installed GPU driver version, CUDA version, and the status of GPU-related services. This is useful for verifying the GPU setup. ```bash olares-cli gpu status ``` -------------------------------- ### List User's Olares Apps Source: https://github.com/beclab/olares/blob/main/cli/skills/olares-market/references/olares-market-list.md Use this command to get a broad inventory of your installed Olares applications, similar to the SPA My Terminus parity. ```bash market list --mine ``` -------------------------------- ### Example Knowledge Base Description Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openwebui-knowledge.md Provide a clear description for your knowledge base, such as 'Frequently asked questions and support guides for Olares products'. ```plain text Frequently asked questions and support guides for Olares products ``` -------------------------------- ### Start TradingAgents CLI Source: https://github.com/beclab/olares/blob/main/docs/use-cases/tradingagents.md Run this command in the terminal to start the TradingAgents framework. Follow the on-screen prompts to configure your analysis. ```bash tradingagents ``` -------------------------------- ### Configure System Environment Source: https://github.com/beclab/olares/blob/main/docs/developer/install/installation-process.md This output shows the installation script preparing the Linux environment, checking system configurations, and installing OS dependencies. ```bash preparing installation environment... current: root 2024-12-17T19:46:39.517+0800 [Job] [Prepare the System Environment] start ... 2024-12-17T19:46:39.517+0800 [Module] PreCheckOs 2024-12-17T19:46:39.517+0800 [A] LocalHost: PreCheckSupport success (29.999µs) 2024-12-17T19:46:39.517+0800 [A] LocalHost: PreCheckPortsBindable success (144.035µs) 2024-12-17T19:46:39.517+0800 [A] LocalHost: PreCheckNoConflictingContainerd success (31.009µs) 2024-12-17T19:46:39.517+0800 [A] ubuntu: PatchAppArmor skipped (7.677µs) 2024-12-17T19:46:39.517+0800 [A] ubuntu: RaspbianCheck success (5.796µs) 2024-12-17T19:46:39.517+0800 [A] ubuntu: CorrectHostname success (5.363µs) nameserver nameserver 2024-12-17T19:46:41.921+0800 [A] ubuntu: DisableLocalDNS success (2.40336625s) 2024-12-17T19:46:41.921+0800 [INFO] installing and configuring OS dependencies ... 2024-12-17T19:46:41.921+0800 [Module] InstallDeps Hit:1 http://security.ubuntu.com/ubuntu jammy-security InRelease Hit:2 https://download.docker.com/linux/ubuntu jammy InRelease Hit:3 http://hk.archive.ubuntu.com/ubuntu jammy InRelease ... ``` -------------------------------- ### Start OpenClaw Personalization Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openclaw.md Send 'Wake up please!' to initiate the persona setup process with the agent. This allows you to establish the agent's identity, behavioral boundaries, and long-term memory. ```text Wake up please! ``` -------------------------------- ### Display Olares CLI version info Source: https://github.com/beclab/olares/blob/main/docs/developer/install/cli/info.md Run this command to get general information about your Olares installation. Use the `--help` or `-h` flag to see available options. ```bash olares-cli info ``` -------------------------------- ### Start OpenClaw Web Configuration Source: https://github.com/beclab/olares/blob/main/docs/use-cases/openclaw-web-access.md Initiates the configuration wizard for OpenClaw's web settings. This command is used to set up web search and fetching providers. ```bash openclaw configure --section web ``` -------------------------------- ### Get Message List (Chat) URL Parameters Source: https://github.com/beclab/olares/blob/main/docs/developer/develop/advanced/ai.md Example URL parameters for retrieving a list of chat messages within a specific conversation. The conversation ID must be provided. ```url /apps/{uuid:app_id}/chat-messages?conversation_id={conversation_id} ``` -------------------------------- ### RabbitMQ Deployment YAML and Connection String Example Source: https://github.com/beclab/olares/blob/main/docs/developer/develop/package/manifest.md Map RabbitMQ middleware configuration to environment variables and construct the AMQP connection URL using Go. ```yaml # For RabbitMQ, the corresponding value is as follows - env: - name: RABBITMQ_HOST value: '{{ .Values.rabbitmq.host }}' - name: RABBITMQ_PORT value: "{{ .Values.rabbitmq.port }}" - name: RABBITMQ_USER value: "{{ .Values.rabbitmq.username }}" - name: RABBITMQ_PASSWORD value: "{{ .Values.rabbitmq.password }}" - name: RABBITMQ_VHOST value: "{{ .Values.rabbitmq.vhosts.aaa }}" user := os.Getenv("RABBITMQ_USER") password := os.Getenv("RABBITMQ_PASSWORD") vhost := os.Getenv("RABBITMQ_VHOST") host := os.Getenv("RABBITMQ_HOST") portMQ := os.Getenv("RABBITMQ_PORT") url := fmt.Sprintf("amqp://%s:%s@%s:%s/%s", user, password, host, portMQ, vhost) ``` -------------------------------- ### Complete OlaresManifest.yaml Example Source: https://github.com/beclab/olares/blob/main/docs/developer/contribute/system-app/olares-manifest.md An example of a full `OlaresManifest.yaml` file, including metadata, entrances, spec, permissions, and options. ```yaml olaresManifest.version: 1 olaresManifest.type: app metadata: name: desktop icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp description: app desktop appid: desktop title: desktop version: 0.0.2 categories: - dev entrances: - name: desktop-frontend-dev host: desktop-svc-dev port: 80 icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp title: Desktop-dev authLevel: private openMethod: default spec: versionName: 0.0.1 requiredMemory: 2Gi requiredDisk: 50Mi supportArch: - amd64 requiredCpu: 50m limitedMemory: 3Gi limitedCpu: 1000m permission: appData: true appCache: true userData: [] sysData: - group: service.bfl dataType: app version: v1 ops: - UserApps - group: service.appstore dataType: app version: v1 ops: - UninstallDevApp - group: service.bfl dataType: datastore version: v1 ops: - GetKey - GetKeyPrefix - SetKey - DeleteKey - group: service.files dataType: files version: v1 ops: - Query options: resetCookie: enabled: false dependencies: - name: olares version: '>=0.1.0' type: system appScope: clusterScoped: false appRef: [] ``` -------------------------------- ### Initiate Conversation with Custom Agent Source: https://github.com/beclab/olares/blob/main/docs/use-cases/lobechat.md Start a conversation with your newly created custom agent by providing a specific request. This example shows how to ask for content related to a particular search term. ```text I want to rank for "local AI alternatives" ``` -------------------------------- ### Run olares-cli inside WSL Source: https://github.com/beclab/olares/blob/main/docs/developer/install/cli/olares-cli.md If Olares was installed using the WSL method, execute olares-cli commands within the WSL environment. This example shows how to enter the Ubuntu WSL distribution. ```powershell wsl -d Ubuntu ``` -------------------------------- ### Create SMB Share for SMB Users Source: https://github.com/beclab/olares/blob/main/cli/skills/olares-files/references/olares-files-share.md Example of creating an SMB share and assigning permissions to specific SMB user accounts. ```bash olares-cli files share smb drive/Home/Movies/ \ --users smb-uid-1:edit,smb-uid-2:edit ``` -------------------------------- ### Get Information on a System Package with pkg-install Source: https://github.com/beclab/olares/blob/main/docs/use-cases/opencode-packages.md Display detailed information about a specific system package. Replace `` with the name of the package you are interested in. ```bash pkg-install --info ``` -------------------------------- ### Full Custom-Chart Lifecycle Example Source: https://github.com/beclab/olares/blob/main/cli/skills/olares-market/references/olares-market-charts.md This snippet demonstrates a complete cycle for a custom chart: uploading, installing with watching, using the app, uninstalling, and finally deleting the chart from local sources. ```bash # Full custom-chart cycle. olares-cli market upload ./mychart-1.0.0.tgz # land it in source=upload olares-cli market install mychart -s upload --version 1.0.0 --watch # ... use the app ... olares-cli market uninstall mychart --watch # tear down the deployment olares-cli market delete mychart --version 1.0.0 # remove the chart from local sources ```