Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 14 additions & 9 deletions docs/get-started/javascript.md → docs/get-started/typescript.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Java Quickstart for ADK
# TypeScript Quickstart for ADK

This guide shows you how to get up and running with Agent Development Kit
for JavaScript. Before you start, make sure you have the following installed:
for TypeScript. Before you start, make sure you have the following installed:

* Node.js 20.12.7 or later
* Node Package Manager (npm) 9.2.0 or later
Expand Down Expand Up @@ -39,11 +39,11 @@ my-agent/
```

**Note:** Do not create `tsconfig.json`, you generate that
file in a later step.
file in a later step.

### Define the agent code

Create the code for a basic agent, including a simple implementation of an ADK
Create the code for a basic agent, including a simple implementation of an ADK
[Function Tool](/adk-docs/tools/function-tools/), called `getCurrentTime`.
Add the following code to the `agent.ts` file in your project
directory:
Expand Down Expand Up @@ -77,7 +77,7 @@ export const rootAgent = new LlmAgent({
### Configure project and dependencies

Use the `npm` tool to install and configure dependencies for your project,
including the package file, TypeScript configuration, ADK JavaScript main
including the package file, TypeScript configuration, ADK TypeScript main
library and developer tools:

```console
Expand Down Expand Up @@ -115,8 +115,8 @@ well as the ADK library dependencies, as shown in this example:
}
```

For development convenience, in the `tsconfig.json` file, update the
setting for `verbatimModuleSyntax` to `false` to allow simpler syntax
For development convenience, in the `tsconfig.json` file, update the
setting for `verbatimModuleSyntax` to `false` to allow simpler syntax
when adding modules:

```json title="my-agent/tsconfig.json"
Expand All @@ -136,7 +136,7 @@ npx tsc
### Set your API key

This project uses the Gemini API, which requires an API key. If you
don't already have Gemini API key, create a key in Google AI Studio on the
don't already have Gemini API key, create a key in Google AI Studio on the
[API Keys](https://aistudio.google.com/app/apikey) page.

In a terminal window, write your API key into your `.env` file of your project
Expand All @@ -160,7 +160,7 @@ interact with your agent.

### Run with command-line interface

Run your agent with the ADK JavaScript command-line interface tool
Run your agent with the ADK TypeScript command-line interface tool
using the following command:

```console
Expand All @@ -183,6 +183,11 @@ upper right corner and type a request.

![adk-web-dev-ui-chat.png](/adk-docs/assets/adk-web-dev-ui-chat.png)

!!! warning "Caution: ADK Web for development only"

ADK Web is ***not meant for use in production deployments***. You should
use ADK Web for development and debugging purposes only.

## Next: Build your agent

Now that you have ADK installed and your first agent running, try building
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,9 @@ nav:
- Get Started:
- get-started/index.md
- Python: get-started/python.md
- TypeScript: get-started/typescript.md
- Go: get-started/go.md
- Java: get-started/java.md
- TypeScript: get-started/javascript.md
- Build your Agent:
- tutorials/index.md
- Multi-tool agent: get-started/quickstart.md
Expand Down
Loading