> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.

# globals

- **Type:** `boolean`
- **Default:** `false`
- **CLI:** `--globals`

Provide global Rstest APIs for test files, such as `expect`, `test`, `describe`, etc.

By default, Rstest does not provide global APIs. If you prefer to use the APIs globally like Jest, you can add `globals: true` in the config or pass the `--globals` option to CLI.


**CLI**

```bash
npx rstest --globals
```


**rstest.config.ts**

```ts
import { defineConfig } from '@rstest/core';

export default defineConfig({
  globals: true,
});
```


## Usage

When you enable `globals`, you can use the global APIs directly without `import { ... } from '@rstest/core'`.

```diff title="index.test.ts"
- import { describe, expect, it } from '@rstest/core';

describe('Index', () => {
  it('should add two numbers correctly', () => {
    expect(1 + 1).toBe(2);
  });
});
```

## Available global APIs

When `globals` is enabled, Rstest injects the following globals:

- `test`
- `describe`
- `it`
- `expect`
- `assert`
- `beforeAll`
- `afterAll`
- `beforeEach`
- `afterEach`
- `onTestFinished`
- `onTestFailed`
- `rs`
- `rstest`

`rs` and `rstest` are aliases with the same runtime utilities.

### TypeScript support

To enable TypeScript to properly recognize the global APIs, we recommend adding `@rstest/core/globals` to `compilerOptions.types` in the `tsconfig.json` for your test files:

```json title=tsconfig.json
{
  "compilerOptions": {
    "types": ["@rstest/core/globals"]
  }
}
```

> If your `tsconfig.json` already configures `compilerOptions.types`, append this type to the existing list.

Alternatively, create a `src/rstestEnv.d.ts` file to reference the type definitions:

```ts title=rstestEnv.d.ts
/// <reference types="@rstest/core/globals" />
```