Skip to content

Commit d11d31f

Browse files
committedMar 26, 2024
Chore: use positional args and remove IPFS section from quick start
1 parent 09bb6e7 commit d11d31f

File tree

2 files changed

+13
-18
lines changed

2 files changed

+13
-18
lines changed
 

‎src/content/docs/everycli/local-dev.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ Running the Every CLI will start a [Homestar](/homestar/what-is-homestar/) node,
2222
#### To create a single function Homestar workflow
2323

2424
```shell
25-
every dev --fn <PATH_TO_FUNCTION_FILE>
25+
every dev <PATH_TO_FUNCTION_FILE>
2626
```
2727

2828
#### To create a multi-function Homestar workflow
2929

3030
```shell
31-
every dev --fn <PATH_TO_FUNCTION_FILE> --fn <PATH_TO_OTHER_FUNCTION_FILE>
31+
every dev <PATH_TO_FUNCTION_FILE> <PATH_TO_OTHER_FUNCTION_FILE>
3232
```
3333

3434
## Function development loop
@@ -57,7 +57,7 @@ export function hello(name: string): string {
5757
Start the CLI and point it to your custom TypeScript function
5858

5959
```shell
60-
every cli dev --fn <PATH_TO_YOUR_FUNCTION_DIR>/hello.ts
60+
every cli dev <PATH_TO_YOUR_FUNCTION_DIR>/hello.ts
6161
```
6262

6363
</TabItem>
@@ -177,7 +177,7 @@ This command will produce a `hello.wasm` component.
177177
Start the CLI and point it to your custom Wasm function
178178

179179
```shell
180-
every cli dev --fn <PATH_TO_YOUR_FUNCTION_DIR>/hello.wasm
180+
every cli dev <PATH_TO_YOUR_FUNCTION_DIR>/hello.wasm
181181
```
182182

183183
## Setting up a tunnel
@@ -193,7 +193,7 @@ By default the [every-cli](https://github.com/everywhere-computer/every-cli) wil
193193
If you would like to specify your own `toml` file to be used as the configuration for Homestar, you can use the `--config` argument:
194194

195195
```shell
196-
every cli dev --fn <PATH_TO_YOUR_FUNCTION_DIR>/hello.wasm --config ../<YOUR_CONFIG_FILE_NAME>.toml
196+
every cli dev <PATH_TO_YOUR_FUNCTION_DIR>/hello.wasm --config ../<YOUR_CONFIG_FILE_NAME>.toml
197197
```
198198

199199
You can specify as many or as few values in your `toml` file as you like and the [every-cli](https://github.com/everywhere-computer/every-cli) will prioritize the values from your config over the default values.

‎src/content/docs/quick-start.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,10 @@ Get introduced to the Everywhere Computer's core concepts while using the `every
99
npm i -g @everywhere-computer/every-cli
1010
```
1111

12-
## Setup & Run a Local IPFS Node
13-
14-
The Everywhere Computer is both portable and durable. These two traits are made possible by [IPFS’ content addressing](https://fission.codes/blog/content-addressing-what-it-is-and-how-it-works/) and WebAssembly's ability to execute in _any_ environment — including browsers.
15-
16-
If you are not already running an IPFS Kubo node on your local machine:
17-
1. Download & install the [IPFS Desktop](https://docs.ipfs.tech/install/ipfs-desktop/) client.
18-
2. Launch the IPFS Desktop client — this will ensure an IPFS node is running on your local machine.
19-
2012
## Run Your First Function
2113

22-
Clone down our [custom TypeScript functions repo](https://github.com/everywhere-computer/custom-homestar-functions-ts). In the `src/functions` directory you'll find four *very* basic functions:
14+
Clone down our [custom TypeScript functions repo](https://github.com/everywhere-computer/custom-homestar-functions-ts). In the `src/functions` directory you'll find four _very_ basic functions:
15+
2316
1. `add.ts` - adds two numbers together
2417
2. `concat.ts` - concatenates two strings
2518
3. `hello.ts` - a simple `hello ${world}`
@@ -30,16 +23,17 @@ Clone down our [custom TypeScript functions repo](https://github.com/everywhere-
3023
Let's begin with `hello.ts`. From the root directory of the repository run:
3124

3225
```shell
33-
every dev --fn src/functions/hello.ts
26+
every dev src/functions/hello.ts
3427
```
3528

3629
This should produce an output like the following in your terminal:
30+
3731
```bash
3832
✔ Functions parsed and compiled
3933
✔ Homestar is running at http://127.0.0.1:8020
4034
✔ Control Panel is running at https://control.everywhere.computer
4135

42-
◐ Starting cloudflared tunnel to http://127.0.0.1:3000/
36+
◐ Starting cloudflared tunnel to http://127.0.0.1:3000/
4337

4438
... a QR code ...
4539

@@ -48,6 +42,7 @@ This should produce an output like the following in your terminal:
4842
```
4943

5044
Everything is now ready to run your function:
45+
5146
1. **The function has been compiled to WebAssembly (Wasm)** which is the Everywhere Computer's native format.
5247
2. **A local Homestar node** is running — these are what power the Everything Computer.
5348
3. **A local instance of the Control Panel** is running so that we can interact with our local Homestar node.
@@ -84,11 +79,11 @@ Workflows can be big. They can be small. They can run in isolation. They can be
8479
Let's construct a two task workflow to test this out. To do this, we'll instruct the cli to compile both the `hello` and `concat` functions:
8580

8681
```shell
87-
every dev --fn src/functions/hello.ts --fn src/functions/concat.ts
82+
every dev src/functions/hello.ts src/functions/concat.ts
8883
```
8984

9085
![A Multi-Function Workflow](./assets/quickstart-2.jpeg)
9186

9287
## Next Steps
9388

94-
For additional instructions on local development with the `every cli` — including writing custom functions in TypeScript and Rust — check out [Every CLI Usage](/everycli/local-dev).
89+
For additional instructions on local development with the `every cli` — including writing custom functions in TypeScript and Rust — check out [Every CLI Usage](/everycli/local-dev).

0 commit comments

Comments
 (0)
Please sign in to comment.