run-llama/llamactl-windows
1
0
Fork 0
mirror of https://github.com/run-llama/llamactl-windows.git synced 2026-07-01 20:44:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2 from run-llama/docs/readme-reduction

Browse Source 
docs: reduce readme and point to official documentation
This commit is contained in:
Clelia (Astra) Bertelli
2025-10-23 21:49:58 +02:00
committed by GitHub
parent 18bb5f9407 ca91816ca6
commit 3ffc39f0a6
2 changed files with 3 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -90
View File
@@ -22,103 +22,16 @@ To install and run `llamactl` successfully, make sure you have the following pro
- Python (with `pip`)
- `uv`
- Node.js (with `npm`)
- Node.js (with `npm` and `corepack`)
- Git
Optionally, you can also install `corepack`.
You can either use the scripts in [`scripts/installation/`](./scripts/installation/) to install specific dependencies or run the main setup script to install everything at once (note: this may take some time):
```ps
.\setup.ps1
```
## Get Started with a Template
## Using `llamactl`
Since `llamactl init` uses symbolic links, it’s best to enable **Developer Mode** in PowerShell by running:
Once you have all the dependencies installed, the usage flow for `llamactl` is the same across operating systems: refer to our [documentation](https://developers.llamaindex.ai/python/cloud/llamaagents/getting-started/) to get started with your first LlamaAgent!
```ps
start ms-settings:developers
```
You’ll be prompted to enable Developer Mode in your system settings if it’s not already active.
Next, initialize your project:
```ps
llamactl init
```
For this example, select the **basic UI template** and save it as `basic-ui`.
## Serve the Template Locally
Once you have your template, navigate into the project folder and start the local server:
```ps
cd basic-ui/
llamactl serve
```
Your application will be available at:
**http://127.0.0.1:4501/deployments/app/ui/**
### Test the Backend
To verify the backend workflow, first test the health check and available workflows on your local server:
```ps
cd ..
.\scripts\test-backend\test_backend_basics.ps1
```
Then, try running the default workflow:
```ps
.\scripts\test-backend\test_backend_run.ps1
```
## Deploy
To deploy, start from a clean directory: make sure you’re outside of this or any other Git repository.
Once there, you can repeat the `init` and `serve` steps to confirm everything works correctly.
Then, create a new GitHub repository named **`llamactl-test-deployment`**. When ready, link it as your remote:
```ps
git remote add origin https://github.com/<your-username>/llamactl-test-deployment
```
Add, commit, and push your local changes to the `main` branch:
```ps
git branch -M main
git add .
git commit -m "first commit"
git push -u origin main # use --force if needed to bypass branch rules
```
Once your GitHub repository is set up, authenticate with **LlamaCloud** to deploy your agent.
The easiest way is to use your LlamaCloud **API key** and **project ID**:
```ps
llamactl auth token --project-id YOUR_LLAMA_CLOUD_PROJECT_ID --api-key YOUR_LLAMA_CLOUD_API_KEY --no-interactive
```
Finally, create the deployment:
```ps
llamactl deployments create
```
This will open a terminal interface prompting you to select your GitHub repository source and reference.
Make sure the source points to:
```
https://github.com/<your-username>/llamactl-test-deployment
```
and the reference is set to `main`.
Click **Save** to start the deployment.
If everything is configured correctly, your first application should appear on the **Agents** page of your LlamaCloud account within a few minutes!
scripts/installation/install_corepack.ps1
-2
View File
@@ -1,2 +0,0 @@
npm install -g corepack
corepack enable