# Dotfiles

## GetDotfilesConfiguration

`client.users.dotfiles.get(DotfileGetParamsbody, RequestOptionsoptions?): DotfileGetResponse`

**post** `/gitpod.v1.UserService/GetDotfilesConfiguration`

Gets the dotfiles for a user.

Use this method to:

- Retrieve user dotfiles

### Examples

- Get dotfiles:

  Retrieves the dotfiles for the current user.

  ```yaml
  {}
  ```

### Parameters

- `body: DotfileGetParams`

  - `empty?: boolean`

### Returns

- `DotfileGetResponse`

  - `dotfilesConfiguration: DotfilesConfiguration`

    - `repository?: string`

      The URL of a dotfiles repository.

### Example

```typescript
import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const dotfile = await client.users.dotfiles.get();

console.log(dotfile.dotfilesConfiguration);
```

#### Response

```json
{
  "dotfilesConfiguration": {
    "repository": "https://example.com"
  }
}
```

## SetDotfilesConfiguration

`client.users.dotfiles.set(DotfileSetParamsbody, RequestOptionsoptions?): DotfileSetResponse`

**post** `/gitpod.v1.UserService/SetDotfilesConfiguration`

Sets the dotfiles configuration for a user.

Use this method to:

- Configure user dotfiles
- Update dotfiles settings

### Examples

- Set dotfiles configuration:

  Sets the dotfiles configuration for the current user.

  ```yaml
  {
    "repository": "https://github.com/gitpod-io/dotfiles",
  }
  ```

- Remove dotfiles:

  Removes the dotfiles for the current user.

  ```yaml
  {}
  ```

### Parameters

- `body: DotfileSetParams`

  - `repository?: string`

### Returns

- `DotfileSetResponse = unknown`

### Example

```typescript
import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.users.dotfiles.set();

console.log(response);
```

#### Response

```json
{}
```

## Domain Types

### Dotfiles Configuration

- `DotfilesConfiguration`

  - `repository?: string`

    The URL of a dotfiles repository.

### Dotfile Get Response

- `DotfileGetResponse`

  - `dotfilesConfiguration: DotfilesConfiguration`

    - `repository?: string`

      The URL of a dotfiles repository.

### Dotfile Set Response

- `DotfileSetResponse = unknown`