Skip to content
Merged
Changes from 4 commits
Commits
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
72 changes: 72 additions & 0 deletions cheatsheet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# 🌊 Ocean Protocol VS Code Extension — User Cheatsheet

Run **Compute-to-Data jobs** directly from VS Code.

---

## ✅ Requirements

- VS Code **v1.96.0 or higher**
- Algorithm file open (`.py` or `.js`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer needed, we switched to "New project"/"Select project" style


---

## 📦 Installation

1. Install from [VS Code Marketplace](https://marketplace.visualstudio.com/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add link to extension, not to marketplace here

2. Open the **Ocean Protocol** panel (left Activity Bar).
3. Configure settings:
- **Node URL** (default provided)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They have defaults

- **Algorithm file** (mandatory provided)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"New project"/"Select project" style

- **Results folder** (mandatory provided)
- (Optional) Custom Docker image/tag
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One or other (not both)

- (Optional) Dockerfile

---

## ▶️ Running a Compute Job

1. Open an **algorithm file** (`.js` or `.py`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Project style

2. (Optional) Select:
- Dataset file
3. Select **Results folder**
4. In the **Ocean panel**, click **Start Compute Job**.
5. Watch logs & job status in the **Output panel**.
6. When finished, results file opens automatically in VS Code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They do not pop up anymore, you have the logs in output channel and a copy in results/logs


---

## ⚡ Tips

- **Free compute credits** available for dev/testing.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Free compute does not require credits

- Switch settings anytime in the **Ocean panel**.
- Logs & errors show up in the **Output** or **Terminal**.
- Supports both **Python** and **JavaScript** algorithms.
- The extension allows to import **Dockerfiles**, instead typing docker image and docker tag.

---

## 🛠️ Troubleshooting

- ❌ Job not running → check Node URL.
- ❌ Compute environment fails → adjust Node URL.
- Always check **extension logs** in Output.

---

## 🔄 Workflow Summary

| Step | Action |
| ---- | -------------------------------------------- |
| 1 | Open algorithm file (`.py` or `.js`) |
| 2 | Configure node, output folder in Ocean panel |
| 3 | Click **Start Compute Job** |
| 4 | Monitor logs & job status |
| 5 | Results open automatically in VS Code |

---

## 📚 Resources

- [Ocean Protocol Docs](https://docs.oceanprotocol.com/developers/vscode)
- [GitHub Repo](https://github.com/oceanprotocol/vscode-extension)
Loading