Home

Welcome to the Ivy-Framework Internal Developer Wiki!

This wiki is for internal developers of the Ivy Framework. To learn how to use Ivy Framework, visit https://docs.ivy.app.

If you want to work on the framework itself, you need to set up the following:

Install dependencies:
- Node 22.12+ & npm
Fork and clone this repository.
Pre-generate documentation files (first time only):

Windows (PowerShell):
```
cd Ivy.Docs.Shared
.\Regenerate.ps1
```
Mac/Linux (Bash):
```
cd Ivy.Docs.Shared
sh ./Regenerate.sh
```

Build the frontend:

cd frontend
npm install
npm run build
npm run dev

Run the backend (choose one):

For Ivy.Samples (testing components):
```
cd Ivy.Samples
dotnet watch
```
For Ivy.Docs (documentation):
```
cd Ivy.Docs
dotnet watch
```
Open http://localhost:5173/ in your browser.

Changes in /frontend will be hot-reloaded by Vite and changes in /Ivy.Samples will be hot-reloaded by Ivy.

For detailed contribution guidelines, see CONTRIBUTING.md.

Install Rosetta 2: /usr/sbin/softwareupdate --install-rosetta --agree-to-license

Set the environment variable IVY_DUMP_WIDGET_TREES to 1 to log widget tree updates to dump.ljson in the working directory.

$env:IVY_DUMP_WIDGET_TREES = "1"