morten/mini-loader
1
0
Fork 0
mirror of https://github.com/morten-olsen/mini-loader.git synced 2026-02-08 01:36:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: switched from worker API to fs based

Browse Source
This commit is contained in:
Morten Olsen
2024-01-12 14:14:40 +01:00
parent 6d8e5bf955
commit 59d6faaafc
38 changed files with 458 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/first-workload.md
View File

@@ -15,14 +15,19 @@ npm install -g @morten-olsen/mini-loader-cli
Now, let's write a basic script that outputs a single artifact named “hello”. Create a new file with the following JavaScript code:
```javascript
import { artifacts } from "@morten-olsen/mini-loader";
import { artifacts } from '@morten-olsen/mini-loader';
artifacts.create('hello', 'world');
const run = async () => {
artifacts.create('hello', 'world');
};
run();
```
Save this file as `script.mjs`.
Save this file as `script.js`.
#### A Note on Dependencies
In this script, we're using the `@morten-olsen/mini-loader` package, which might not be installed in your local environment. No worries though, as mini loader can automatically download necessary packages when preparing the script. Alternatively, for a more structured approach (especially if you're using TypeScript), you can initialize a Node.js project and install the dependencies for complete access to typings.
### Step 3: Run the Script Locally
@@ -30,7 +35,7 @@ In this script, we're using the `@morten-olsen/mini-loader` package, which might
To validate that your script is functioning correctly, execute it locally using the following command:
```bash
mini-loader local run script.mjs -ai
mini-loader local run script.js -ai
```
The `-ai` flag instructs the CLI to automatically download any referenced packages when bundling the script.
@@ -41,4 +46,4 @@ After running the command, you should see an output confirming that a new artifa
Congratulations on setting up and running your first script with mini loader! You're now ready to take the next step.
[Next: Setting Up the Server](./setup-server.md)
[Next: Setting Up the Server](./setup-server.md)

4
docs/interacting-with-server.md
View File

@@ -58,7 +58,7 @@ mini-loader artifacts ls
To download a specific artifact:
```bash
mini-loader artifacts pull <id> > myfile.txt
mini-loader artifacts pull <id> myfile.txt
```
Replace `<id>` with the identifier of the artifact you wish to download.
@@ -67,4 +67,4 @@ Replace `<id>` with the identifier of the artifact you wish to download.
You're now equipped to manage loads, runs, logs, and artifacts using the mini loader CLI. For advanced usage, such as managing secrets, proceed to the next section.
[Next: Managing Secrets](./managing-secrets.md)
[Next: Managing Secrets](./managing-secrets.md)