Skip to content

Commit 8bccec5

Browse files
docs: replace juno dev with emulator or functions (#522)
* docs: replace juno dev with emulator or functions Signed-off-by: David Dal Busco <david.dalbusco@outlook.com> * chore: fmt Signed-off-by: David Dal Busco <david.dalbusco@outlook.com> * 📄 Update LLMs.txt snapshot for PR review --------- Signed-off-by: David Dal Busco <david.dalbusco@outlook.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 2e325cb commit 8bccec5

11 files changed

Lines changed: 60 additions & 60 deletions

File tree

.llms-snapshots/llms-full.txt

Lines changed: 39 additions & 39 deletions
Large diffs are not rendered by default.

docs/build/functions/development/rust.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ include_satellite!();
2222

2323
## Feature Selection
2424

25-
When you run `juno dev eject`, all the available hooks and assertions are scaffolded in your `lib.rs` module. However, if you don’t have to implement all of them for example to improve readability or reduce unnecessary logic, you can selectively enable only the features you need.
25+
When you run `juno functions eject`, all the available hooks and assertions are scaffolded in your `lib.rs` module. However, if you don’t have to implement all of them for example to improve readability or reduce unnecessary logic, you can selectively enable only the features you need.
2626

2727
To do this, disable the default features in your `Cargo.toml` and explicitly specify only the ones you want to use.
2828

docs/build/functions/lifecycle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ If you start the emulator (see chapter below) in watch mode, your functions will
2424

2525
## Local Development
2626

27-
For local development and testing, a sandbox environment is essential. You can establish this environment by running the CLI command `juno dev start`.
27+
For local development and testing, a sandbox environment is essential. You can establish this environment by running the CLI command `juno emulator start`.
2828

2929
:::info
3030

3131
Find more information about local development in the [documentation](../../guides/local-development.mdx).
3232

3333
:::
3434

35-
The local sandbox environment supports hot reloading. This means that the container will automatically redeploy your local Satellite each time `juno dev build` is executed and a new version is produced.
35+
The local sandbox environment supports hot reloading. This means that the container will automatically redeploy your local Satellite each time `juno functions build` is executed and a new version is produced.
3636

3737
If you start the emulator with the `--watch` flag, it will also rebuild your functions automatically when changes are detected.
3838

@@ -144,7 +144,7 @@ A quick reference for the most common CLI commands and deployment workflows when
144144
| Command(s) | Scenario |
145145
| ---------------------- | ------------------------------------------------------------------------------------ |
146146
| `juno functions eject` | Initializes your project for writing serverless functions. |
147-
| `juno dev start` | Starts the emulator. |
147+
| `juno emulator start` | Starts the emulator. |
148148
| `juno functions build` | Compiles your custom Satellite's code. Changes are automatically redeployed locally. |
149149

150150
### 🚀 Deployment Scenarios

docs/examples/components/how-to-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ Requires the Juno CLI to be available `npm i -g @junobuild/cli`
1515
:::
1616

1717
```bash
18-
juno dev start
18+
juno emulator start
1919
```

docs/guides/components/emulator.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ npm i -g @junobuild/cli
77
Once installed, start the local emulator:
88

99
```bash
10-
juno dev start
10+
juno emulator start
1111
```
1212

1313
Open the Console UI at [http://localhost:5866/](http://localhost:5866/).

docs/guides/components/functions/setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ import Cli from "../cli.mdx";
99
At the root of your application, eject the Satellite if you haven't already used a template.
1010

1111
```bash
12-
juno dev eject
12+
juno functions eject
1313
```

docs/guides/e2e.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ jobs:
140140
- name: Run emulator
141141
run: |
142142
set -e
143-
juno dev start --headless &
144-
juno dev wait
143+
juno emulator start --headless &
144+
juno emulator wait
145145
juno login --emulator --mode development --headless
146146
juno config --mode development --headless
147147
@@ -176,8 +176,8 @@ So, how it works:
176176
177177
- We start by checking out the code, installing Node.js, and running `npm ci` to install your project dependencies.
178178
- As mentioned, instead of the Juno GitHub Actions, we install the Juno CLI globally so we can use it in the next steps.
179-
- We then run the emulator using `juno dev start --headless`, which launches the `junobuild/satellite` Docker image (defined in the `juno.config`) in the background, and follow up with:
180-
- `juno dev wait` to ensure the emulator is ready before continuing.
179+
- We then run the emulator using `juno emulator start --headless`, which launches the `junobuild/satellite` Docker image (defined in the `juno.config`) in the background, and follow up with:
180+
- `juno emulator wait` to ensure the emulator is ready before continuing.
181181
- `juno login` sets up authentication against the emulator in headless mode. This way the CLI can operate the Satellite — required for the next step.
182182
- `juno config` applies the configuration and sets the collections required by the project.
183183
- Once everything is ready, we run the end-to-end tests via `npm run e2e:ci`. Replace with the command that runs your tests in headless mode.

docs/guides/local-development.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Juno offers something most platforms don’t: a full local development environme
1313
| What | How |
1414
| ----------------- | ---------------------------------------------- |
1515
| Runtime supported | Docker or Podman |
16-
| Start emulator | `juno dev start` |
17-
| Stop emulator | `juno dev stop` |
16+
| Start emulator | `juno emulator start` |
17+
| Stop emulator | `juno emulator stop` |
1818
| Console UI URL | [http://localhost:5866](http://localhost:5866) |
1919

2020
---
@@ -67,7 +67,7 @@ import Cli from "./components/cli.mdx";
6767
Then, in your project folder, start the local emulator with:
6868

6969
```bash
70-
juno dev start
70+
juno emulator start
7171
```
7272

7373
This will launch the emulator along with all the services needed to develop your project.
@@ -77,7 +77,7 @@ We recommend running this in a dedicated terminal window or tab, while your fron
7777
To stop the emulator, run:
7878

7979
```bash
80-
juno dev stop
80+
juno emulator stop
8181
```
8282

8383
:::note
@@ -137,7 +137,7 @@ When using the `junobuild/skylab` image, the Console UI becomes available by def
137137
http://localhost:5866/
138138
```
139139

140-
Once the emulator is running (`juno dev start`), visit this URL in your browser to explore the Console — where you can create and manage Satellites, and explore features like Datastore, Authentication, Storage, and more.
140+
Once the emulator is running (`juno emulator start`), visit this URL in your browser to explore the Console — where you can create and manage Satellites, and explore features like Datastore, Authentication, Storage, and more.
141141

142142
---
143143

docs/guides/rust.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ import Setup from "./components/functions/setup.mdx";
2020
In a new terminal window, kick off the emulator:
2121

2222
```bash
23-
juno dev start
23+
juno emulator start
2424
```
2525

2626
Now, your local development environment is up and running, ready for you to start coding.
2727

2828
Once you're ready to see your changes in action, compile your code:
2929

3030
```bash
31-
juno dev build
31+
juno emulator build
3232
```
3333

3434
Changes are detected and automatically deployed, allowing you to test your custom code locally almost immediately.
@@ -99,7 +99,7 @@ async fn on_set_doc(context: OnSetDocContext) -> Result<(), String> {
9999
include_satellite!();
100100
```
101101

102-
As outlined in the [Quickstart](#quickstart) chapter, run `juno dev build` to compile and deploy the code locally.
102+
As outlined in the [Quickstart](#quickstart) chapter, run `juno emulator build` to compile and deploy the code locally.
103103

104104
When testing this feature, if you wait a bit before calling the getter, unlike in the previous step, you should now receive the modified "hello: world checked" text set by the hook. This delay occurs because serverless Functions run fully asynchronously from the request-response between your frontend and the Satellite.
105105

docs/guides/typescript.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import Setup from "./components/functions/setup.mdx";
2020
In a new terminal window, kick off the emulator:
2121

2222
```bash
23-
juno dev start --watch
23+
juno emulator start --watch
2424
```
2525

2626
Now, your local development environment is up and running, ready for you to start coding.

0 commit comments

Comments
 (0)