Skip to content

Small updates to Work Locally #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Small updates to Work Locally #57

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edad4ed
updates to Work Locally
jacklynlee31 Oct 30, 2024
e3e7bb6
Adding steps, adjusting some words
jacklynlee31 Nov 12, 2024
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
25 changes: 12 additions & 13 deletions work-locally.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Work Locally
description: "Seamless local-to-cloud experience for rapid experimentation"
description: "Run your Modus app locally on your machine using the Hyp CLI"
---

Building Modus apps is even easier when you add Hypermode. The Hyp CLI extends
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ryanfoxtyler The opening lines sound okay from a more marketing standpoint, but I would love to simplify this down to make it easier to understand. What content/terms from this would you say are a "must"?

Full content: Building Modus apps is even easier when you add Hypermode. The Hyp CLI extends the [local Modus experience](https://docs.hypermode.com/modus/modus-cli) with access to Hypermode-hosted models defined in your [app’s manifest](https://docs.hypermode.com/modus/app-manifest) for rapid experimentation with new AI models.

Copy link
Member

Choose a reason for hiding this comment

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

I think the key is accessing models when running your Modus app locally (but the Modus CLI is responsible for the running of that app locally)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmmm maybe something like: When you are building Modus apps, you can use the Hyp CLI locally to access Hypermode-hosted models defined in your app's manifest.

🤔

Copy link
Member

Choose a reason for hiding this comment

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

That feels really long for a description?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm fine with simplifying!

When you are building Modus apps, you can use the Hyp CLI to access Hypermode models.

or even You can use the Hyp CLI to access Hypermode models.

Expand All @@ -10,21 +10,20 @@ experimentation with new AI models.

## Hyp CLI setup

For access to hosted models, install the Hyp CLI to augment Modus.
1. First, install the Hyp CLI to augment Modus:
Copy link
Member

Choose a reason for hiding this comment

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

I don't particularly want to use this everywhere, but instead of numbers should we use Mintlify's steps? https://mintlify.com/docs/content/components/steps

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ooh, yes, I think that would work nicely. I'll try it out.


<CodeGroup>
<CodeGroup>

```bash MacOS + Linux
curl -sSL http://install.hypermode.com/hyp.sh | bash
```
```bash MacOS + Linux
curl -sSL http://install.hypermode.com/hyp.sh | bash
```

```js Windows
npm install -g @hypermode/hyp-cli
```
```js Windows
npm install -g @hypermode/hyp-cli
```

</CodeGroup>
</CodeGroup>

## Log into Hyp
2. Ensure you're logged in to the Hyp CLI with the `hyp login` command.

Before running `modus dev` to run your Modus app locally, ensure you're logged
into the Hyp CLI with the `hyp login` command.
3. Run `modus dev` to run your Modus app locally.