-
Notifications
You must be signed in to change notification settings - Fork 1
Move Getting Started into the Sidebar and also add to index #187
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.
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
Merged
jhaynie
merged 1 commit into
main
from
jhaynie/agent-331-move-getting-started-to-the-top-on-the-doc-site
Jun 10, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| --- | ||
| title: Getting Started | ||
| description: Get started with Agentuity in minutes | ||
| --- | ||
|
|
||
| import { Step, Steps } from 'fumadocs-ui/components/steps'; | ||
|
|
||
| <Steps> | ||
| <Step> | ||
| ### Create a Free Account | ||
| [Create a free Agentuity account](https://app.agentuity.com/sign-up) or [Sign in](https://app.agentuity.com/sign-in) to the cloud portal. | ||
|
|
||
| If you already have the Agentuity CLI installed, you can skip this step and signup using the CLI. | ||
| </Step> | ||
|
|
||
| <Step> | ||
| ### Install the CLI | ||
|
|
||
| The [Agentuity CLI](/CLI/installation) is a cross-platform command-line tool for working with Agentuity Cloud. It supports Windows (using WSL), MacOS, and Linux. | ||
|
|
||
| <CLICommand command="curl -fsS https://agentuity.sh | sh" /> | ||
| </Step> | ||
|
|
||
| <Step> | ||
| ### Sign up for an Account with the CLI | ||
|
|
||
| You can sign up for a free account using the CLI or skip this step if you already have an account. | ||
|
|
||
| <CLICommand command="agentuity auth signup" /> | ||
| </Step> | ||
|
|
||
| <Step> | ||
| ### Login to Agentuity | ||
|
|
||
| You can skip this step if you used the CLI to sign up for an account, otherwise you must login to your account using the CLI. | ||
|
|
||
| <CLICommand command="agentuity login" /> | ||
| </Step> | ||
|
|
||
| <Step> | ||
| ### Create Your First Project | ||
|
|
||
| You can select a template to get started quickly. | ||
|
|
||
| <CLICommand command="agentuity create" /> | ||
| </Step> | ||
|
|
||
| <Step> | ||
| ### Run Your Agent Locally | ||
|
|
||
| You can run your agent locally to test it out before you deploy it to the cloud. | ||
|
|
||
| <CLICommand command="agentuity dev" /> | ||
| </Step> | ||
|
|
||
| <Step> | ||
| ### Deploy Your Project to the Cloud | ||
|
|
||
| Deploy your agent to the cloud and start using it! 🚀 | ||
|
|
||
| <CLICommand command="agentuity deploy" /> | ||
|
|
||
| <Callout type="info"> | ||
| If you're using an Agentic Code Editor such as [Cursor](https://www.cursor.com), just tell your agent to deploy your project to the cloud such as "Deploy my project to the cloud" and it will do it for you. | ||
| </Callout> | ||
|
|
||
| </Step> | ||
|
|
||
| </Steps> | ||
|
|
||
| ## Recommended Reading | ||
|
|
||
| <Cards> | ||
| <Card | ||
| title="Guides" | ||
| href="/Guides/what-is-an-agent" | ||
| description="Advanced guides for using Agentuity." | ||
| /> | ||
| <Card | ||
| title="Cloud Console" | ||
| href="/Cloud/" | ||
| description="Learn about the Agentuity Console capabilities." | ||
| /> | ||
| <Card | ||
| title="Command Line Interface" | ||
| href="/CLI/installation" | ||
| description="Reference for using Agentuity from the terminal." | ||
| /> | ||
| <Card | ||
| title="Examples & Tutorials" | ||
| href="/Examples/" | ||
| description="Explore sample projects, step-by-step tutorials, and implementation guides." | ||
| /> | ||
| <Card | ||
| title="SDKs & Integration" | ||
| href="/SDKs" | ||
| description="Integrate Agentuity Cloud into your applications using our SDKs and APIs." | ||
| /> | ||
| <Card | ||
| title="Changelogs" | ||
| href="/Changelog" | ||
| description="Changelogs for the Agentuity SDKs and CLI." | ||
| /> | ||
| </Cards> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,9 @@ | ||
| { | ||
| "title": "Introduction", | ||
| "pages": ["index", "architecture", "templates"] | ||
| } | ||
| "pages": [ | ||
| "index", | ||
| "getting-started", | ||
| "architecture", | ||
| "templates" | ||
| ] | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.