Skip to content

docs(sandbox): install Orca plugin by git URL #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pratikbin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(sandbox): install Orca plugin by git URL #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,8 +358,12 @@ Set `CREATEOS_AGENTS` to install coding agents at create time, for example

Orca calls this command itself for each lifecycle phase once its plugin is
installed. The plugin lives in
[NodeOps-app/createos-plugins](https://github.com/NodeOps-app/createos-plugins)
under `packages/orca-plugin`.
[NodeOps-app/createos-orca-plugin](https://github.com/NodeOps-app/createos-orca-plugin).
Install it in Orca under Settings > Plugins > Install from git URL:

```
https://github.com/NodeOps-app/createos-orca-plugin.git#v0.1.0
```

**When to use `exec`, `shell`, `process`, and PTY:**

Expand Down
23 changes: 9 additions & 14 deletions cmd/sandbox/orca.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,10 @@ import (
const (
orcaSchemaVersion = 2
// Orca's git-URL installer clones a whole repo and requires
// orca-plugin.json at its root, so this monorepo subdirectory cannot be
// installed that way. Until it ships as its own single-package repo, the
// only working route is a local checkout via Settings > Plugins > Dev Paths.
orcaPluginRepoURL = "https://github.com/NodeOps-app/createos-plugins"
orcaPluginPkgPath = "packages/orca-plugin"
// orca-plugin.json at its root, so the plugin ships as its own
// single-package repo. Pin the tag: an unpinned URL tracks the default
// branch and can change under an installed workspace.
orcaPluginGitURL = "https://github.com/NodeOps-app/createos-orca-plugin.git#v0.1.0"
orcaDefaultShape = "s-4vcpu-8gb" // remote editors need more than 2 GiB
orcaDefaultRootfs = "devbox:1" // ships sshd, git, Node 22, opencode, pi
orcaDefaultRoot = "/workspace/repo"
Expand Down Expand Up @@ -214,16 +213,12 @@ func runOrcaSetup(c *cli.Context, doctorOnly bool) error {

fmt.Print("\nNext, install the Orca plugin. Orca performs the install itself,\n" +
"so it can show you what the plugin contributes before you approve it.\n\n" +
" 1. Clone " + orcaPluginRepoURL + "\n" +
" 2. Open Orca > Settings > Plugins > Dev Paths\n" +
" 3. Add the path to " + orcaPluginPkgPath + "\n" +
" 4. Approve the \"CreateOS Sandbox\" VM recipe when Orca asks\n" +
" 5. Turn on Settings > Cloud VM\n\n" +
" 1. Open Orca > Settings > Plugins > Install from git URL\n" +
" 2. Paste " + orcaPluginGitURL + "\n" +
" 3. Approve the \"CreateOS Sandbox\" VM recipe when Orca asks\n" +
" 4. Turn on Settings > Cloud VM\n\n" +
"Then pick \"CreateOS Sandbox\" when you create a workspace, under\n" +
"Run on > Per-Workspace Environment.\n\n" +
"Installing by git URL does not work yet: Orca's installer needs\n" +
"orca-plugin.json at a repository root, and the plugin lives in a\n" +
"subdirectory of that monorepo.\n")
"Run on > Per-Workspace Environment.\n")
return nil
}

Expand Down