Skip to content

Commit

Permalink
Update docs for zup link
Browse files Browse the repository at this point in the history
  • Loading branch information
vazexqi committed Aug 23, 2024
1 parent 64c95d8 commit 150beba
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
11 changes: 6 additions & 5 deletions docs/articles/local-development-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,18 @@ To use Zuplo services such as API keys and rate limiting locally, you must have
a Zuplo account and an existing project. You will be using the connections from
your remote gateway.

1. Run `npx zup login` to log into your account in your browser.
2. Run `npx zup link` to bring in relevant information from your Zuplo account
and project. Follow the prompt to select the right environment.
3. At this point, you will see a file called `.env.zuplo` containing some
1. Run `npx zup link` to bring in relevant information from your Zuplo account
and project. Follow the prompt to select the right environment. For local
development, we recommend selecting the development environment.
2. At this point, you will see a file called `.env.zuplo` containing some
information about the account, project, and environment that your local
gateway is linked to.

:::warning

As the .env.zuplo file could contain sensitive information, it should not be
committed to your version system. Consider adding .env to your .gitignore file.
committed to your version system. Consider adding .env.zuplo to your .gitignore
file.

:::

Expand Down
1 change: 0 additions & 1 deletion docs/cli/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Commands:
zup dev Runs the zup locally
zup editor Starts a local Open API Designer
zup link Links information from your Zuplo account to your local machine
zup login Authenticates the user
```

See more examples at [Local Development](../articles/local-development.md).

0 comments on commit 150beba

Please sign in to comment.