# RudderTyper v1 Quickstart


> Install RudderTyper v1, generate a client from a Tracking Plan, and connect it to a RudderStack SDK.




**Warning**

RudderTyper v1 (npm) is in maintenance mode and will not receive any new features.

For TypeScript, Kotlin, and Swift support, use [RudderTyper v2](https://www.rudderstack.com/docs/rudder-cli/ruddertyper-v2/).

## Get started

The following sections will help you set up and use RudderTyper to generate your first client.

### Prerequisites

- Make sure your [Node version](https://nodejs.org/en/about/previous-releases) is v20.x or above
- Clone the [RudderTyper repository](https://github.com/rudderlabs/rudder-typer) in your preferred location
- Generate a [workspace-level Service Access Token](https://www.rudderstack.com/docs/access-management/service-access-tokens/#workspace-sat) in your RudderStack workspace

**Info:** The workspace-level Service Access Token has **Read** permissions by default. You do not need to assign any [resource permissions](https://www.rudderstack.com/docs/access-management/policies-overview/#resource-permissions) while generating the token.

#### Token permissions for legacy RBAC system

If you are on the [legacy Permissions Management (RBAC) system](https://www.rudderstack.com/docs/archive/dashboard-guides/user-management/), your workspace-level Service Access Token should have **Viewer** permission.

See [this documentation](https://www.rudderstack.com/docs/archive/dashboard-guides/service-access-tokens/#generate-service-access-token) for more information on generating the token.

![workspace-level Service Access Token with Viewer permission](/docs/images/access-management/permissions/legacy/viewer.webp)

### Quickstart

The following steps highlight the process of creating a `ruddertyper.yml` file and generate your first RudderTyper client with the specified configuration details:

1. Run the following command to initialize RudderTyper:

```bash
$ npx rudder-typer init  # Or initialize or quickstart
```

2. Choose the SDK type for your RudderTyper client - you can use the up/down arrow key to navigate through the options.

![Choose SDK for RudderTyper client](/docs/images/dev-tools/ruddertyper/choose-sdk.webp)

3. Choose the appropriate language and continue. The following image shows the language options for the Web SDK:

![Choose language option](/docs/images/dev-tools/ruddertyper/choose-language.webp)

4. Enter the [workspace-level Service Access Token](#prerequisites) generated above. RudderTyper uses this token to fetch all the Tracking Plans present in your workspace.

5. Choose the Tracking Plan for which RudderTyper generates the client - this plan is automatically saved locally in a `plan.json` file.

![Choose Tracking Plan](/docs/images/dev-tools/ruddertyper/tracking-plan.webp)

6. Choose the RudderTyper mode. You will see two options - `Production` or `Development`.  See [RudderTyper modes](https://www.rudderstack.com/docs/rudder-cli/ruddertyper-v2-command-reference/v1/#ruddertyper-modes) for more information on each mode.

7. Specify the directory to store the generated RudderTyper client. You can choose an existing directory or create a new one, depending on your requirement.

![Choose directory to store the client](/docs/images/dev-tools/ruddertyper/specify-directory.webp)

8. Review the settings and select **Looks good!** to complete the process. You can select **Edit** to make any changes to the above steps.

![Review settings](/docs/images/dev-tools/ruddertyper/review.webp)

RudderTyper then generates the client based on your configuration settings and stores it in the specified directory. See [Configuration reference](https://www.rudderstack.com/docs/rudder-cli/ruddertyper-v2-command-reference/v1/#configuration-reference) for more information on the `ruddertyper.yml` file structure.

![Generated RudderTyper client](/docs/images/dev-tools/ruddertyper/client-generate.webp)

#### Troubleshooting

- If you get an error during the setup process, run the following commands to clear your cache and local storage:

```bash
npm cache clean --force
rm -r ~/.ruddertyper
```

- If you get a "Your workspace does not have any Tracking Plans" error during the setup, verify that your RudderTyper client is on a stable version (v1.x).

## Integrate RudderTyper client with SDK

This section includes the steps to integrate your RudderTyper-generated client with your app across different RudderStack SDKs.

#### Android (Java) — Legacy

1. Import all files in the client generated by RudderTyper as a package in your project.
2. Make the calls using the RudderTyper client, as shown:
```java
// Import your auto-generated RudderTyper client:
import com.rudderstack.generated.*

  // Issue your first RudderTyper track call
  RudderTyperAnalytics.with(this).orderCompleted(
    OrderCompleted.Builder()
    .orderID("ck-f306fe0e-cc21-445a-9caa-08245a9aa52c")
    .total(39.99)
    .build()
  );
```
#### iOS (Obj-C) — Legacy

1. Import your RudderTyper client into your project using XCode.

**Warning**

If you place the generated files into a folder within your
project, import the project as a group, **not** as a folder reference.

1. Make the calls using the RudderTyper client, as shown:
```objectivec
// Import your auto-generated RudderTyper client:
#import "RSRudderTyperAnalytics.h"

// Issue your first RudderTyper track call
[RSRudderTyperAnalytics orderCompletedWithOrderID: "ck-f306fe0e-cc21-445a-9caa-08245a9aa52c" total: @39.99];
```
#### JavaScript

There are two ways to get started with RudderTyper in your browser:

### Using JavaScript SDK snippet
1. Paste the [JavaScript SDK snippet](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/quickstart/#step-1-install-the-javascript-sdk) from the RudderStack dashboard in your HTML file.
2. If you use TypeScript, add `@rudderstack/analytics-js` as a dev dependency:
```bash
npm install --save-dev  @rudderstack/analytics-js
```
1. Run the below command to generate a bundle from the RudderTyper client:
```bash
npx browserify analytics/index.js --standalone rudderTyper >  rudderTyperBundle.js
```
1. For the TypeScript analytics client, add the npm package `tsify` as a dependency and run the below command to generate the bundle:
```bash
npx browserify analytics/index.ts -p [ tsify ] --standalone rudderTyper >  rudderTyperBundle.js
```
1. Import your RudderTyper client and send events.
```html
<script>
  // Add the JavaScript SDK snippet from https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/quickstart/#step-1-install-the-javascript-sdk
</script>
<script src="./rudderTyperBundle.js"></script>
<script>
  rudderTyper.setRudderTyperOptions({
    analytics: rudderanalytics,
  });
  rudderTyper.orderCompleted({
    orderID: 'ck-f306fe0e-cc21-445a-9caa-08245a9aa52c',
    total: 39.99,
  });
</script>
```

See the [sample application](https://github.com/rudderlabs/rudder-typer/tree/develop/examples/js-cdn-typescript) for more information.

### Using NPM

Import the RudderTyper-generated client and make the calls if your framework supports them.

```javascript
// Import RudderStack JS SDK and initialize it
import { RudderAnalytics } from '@rudderstack/analytics-js';
// Import your auto-generated RudderTyper client:
import { RudderTyperAnalytics } from './analytics/index';

const rudderAnalytics = new RudderAnalytics();
rudderAnalytics.load(WRITE_KEY, DATA_PLANE_URL, {});

// Pass in your @rudderstack/analytics-js instance to RudderTyper client
RudderTyperAnalytics.setRudderTyperOptions({
  analytics: rudderAnalytics,
});

// Issue your first RudderTyper track call
RudderTyperAnalytics.orderCompleted({
  orderID: 'ck-f306fe0e-cc21-445a-9caa-08245a9aa52c',
  total: 39.99,
});
```

Note that:

- Replace `WRITE_KEY` and `DATA_PLANE_URL` in the above snippet with your source write key and [data plane URL](https://www.rudderstack.com/docs/dashboard-guides/#connections) respectively.
- Make sure to run `npx rudder-typer` to regenerate your RudderTyper client every time you update the Tracking Plan.

See the [sample application](https://github.com/rudderlabs/rudder-typer/tree/develop/examples/js-npm-typescript) for more information.
#### Node.js

Import the RudderTyper-generated client and start making calls, as shown:

```javascript
// Import RudderStack Node.js SDK and initialize it
const RudderAnalytics = require('@rudderstack/rudder-sdk-node');

const client = new RudderAnalytics(WRITE_KEY, {
  dataPlaneUrl: DATA_PLANE_URL,
  // Other initialization options
});

const RudderTyperAnalytics = require('./analytics/index');
// Pass in your @rudderstack/rudder-sdk-node instance to RudderTyper.
RudderTyperAnalytics.setRudderTyperOptions({
  analytics: client,
});

// Issue your first RudderTyper track call
RudderTyperAnalytics.orderCompleted({
  orderID: 'ck-f306fe0e-cc21-445a-9caa-08245a9aa52c',
  total: 39.99,
});
```

## See more

- [RudderTyper v1](https://www.rudderstack.com/docs/rudder-cli/ruddertyper-v2/v1/): What v1 generates, and how validation works
- [RudderTyper v1 Reference](https://www.rudderstack.com/docs/rudder-cli/ruddertyper-v2-command-reference/v1/): Commands, modes, and `ruddertyper.yml`
- [End-to-End Walkthrough: RudderTyper v2 with Rudder CLI](https://www.rudderstack.com/docs/rudder-cli/ruddertyper-v2-walkthrough/): Generate bindings with Rudder CLI