Hex

https://learn.hex.tech/docs
Admin
Hex is a collaborative platform for data exploration, analysis, and interactive app building that...
Tokens:358,160
Snippets:2,878
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example hex_context.config.yaml configuration

Source: https://learn.hex.tech/docs/agent-management/context-management/context-sync

Example configuration file showing how to define guides, semanticProjects, and evals for context sync. Use this as a template for your own configuration.

```yaml
guides:
  - path: path/to/my/guide.md
  - path: path_i_want_to_change.md
    hexFilePath: path/that/will/show/up/in/hex.md
  - pattern: guides/*.md
    transform:
      stripFolders: true
  - pattern: guides/**/*.md
semanticProjects:
  - id: <semantic-project-uuid>
    path: path/to/dir
evals:
  suites:
    - path: evals/suite.yaml
```

--------------------------------

### Install Hex CLI with Homebrew

Source: https://learn.hex.tech/docs/api-integrations/cli

Install the Hex CLI using Homebrew by tapping the hex-inc/hex-cli repository, trusting the tap, and installing the hex formula.

```bash
brew tap hex-inc/hex-cli
brew trust --tap hex-inc/hex-cli
brew install hex-inc/hex-cli/hex
```

--------------------------------

### Manually install Hex CLI with curl

Source: https://learn.hex.tech/docs/api-integrations/cli

Alternative installation method using a curl command to download and run the installation script from hex.tech.

```bash
curl -fsSL https://hex.tech/install.sh | bash
```

--------------------------------

### Install Tableau migration skill in Claude Code

Source: https://learn.hex.tech/docs/migrate-to-hex/migrate-from-tableau

Use these commands to install the Tableau migration skill in Claude Code. Start a new chat after installation.

```text
/plugin marketplace add hex-inc/hex-skills
/plugin install tableau-migration@hex-skills
```

--------------------------------

### Install Looker migration skill in Claude Code

Source: https://learn.hex.tech/docs/migrate-to-hex/migrate-from-looker

Install the Looker migration skill in Claude Code using plugin commands. Start a new chat after installation.

```text
/plugin marketplace add hex-inc/hex-skills
/plugin install looker-migration@hex-skills
```

--------------------------------

### Setup

Source: https://learn.hex.tech/docs/api-integrations/api/overview

Configuration code to set up the base URL, project ID, and token for making Hex API requests.

```APIDOC
## Setup

### Description
Set up the base URL, project ID, and token required for Hex API requests.

### Code Example
```python
import requests

# Single tenant, HIPAA, and EU users will need to replace this with their Hex URL
BASE_URL = 'https://app.hex.tech/api/v1'

# Replace this with the project ID
PROJECT_ID = '5a8591dd-4039-49df-9202-96385ba3eff8'

# Replace this with your token (format: hxtp_<96 hex chars> for personal, hxtw_<96 hex chars> for workspace)
TOKEN = 'hxtp_5bbf1c8b1989d6657d5c...'
```
```

--------------------------------

### Set up .ssh directory and authorized_keys for hex user

Source: https://learn.hex.tech/docs/connect-to-data/data-connections/connect-via-ssh

Create the .ssh directory and authorized_keys file with appropriate permissions for the hex user. These commands must be run as the hex user.

```bash
$ mkdir ~/.ssh
$ chmod 700 ~/.ssh
$ cd ~/.ssh
$ touch authorized_keys
$ chmod 600 authorized_keys
```

--------------------------------

### UpsertGuideDraft Request Payload

Source: https://learn.hex.tech/docs/api-integrations/api/reference

Example JSON payload for the UpsertGuideDraft request. The forceWrite field defaults to false; when true, it overwrites an existing guide synced from a different source if a guide of the same name exists.

```json
{
  "forceWrite": true,
  "files": [
    {
      "externalSource": {
        "id": "string",
        "source": "unknown"
      },
      "contents": "string",
      "filePath": "string",
      "property1": null,
      "property2": null
    }
  ]
}
```

--------------------------------

### Reload pkg_resources after package installation

Source: https://learn.hex.tech/docs/explore-data/projects/environment-configuration/using-packages

Resolve ContextualVersionConflict exceptions by reloading pkg_resources after installing a package with uv pip and before importing it. This is needed when a package relies on pkg_resources to check version conflicts during setup.

```python
import pkg_resources
from importlib import reload

!uv pip install {my_package}

reload(pkg_resources)

import {my_package}
```

--------------------------------

### Hex CLI --help command

Source: https://learn.hex.tech/docs/api-integrations/cli

Run 'hex --help' to display CLI usage. Subcommands are also documented with the --help flag, as shown by 'hex auth --help'.

```bash
hex --help

# subcommands are also documented using the `--help` flag
hex auth --help
```

--------------------------------

### GET /v1/guides/draft/list

Source: https://learn.hex.tech/docs/api-integrations/api/reference

Lists draft guides. Supports pagination via limit, after, and before parameters, and optional filtering by externalSource. Requires bearer authentication.

```APIDOC
## GET /v1/guides/draft/list

### Description
List draft guides. This endpoint is subject to rate limits: `hex-api-30rpm` (30 requests per minute).

### Method
GET

### Endpoint
https://app.hex.tech/api/v1/guides/draft/list

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Default: 100. Range: 1 to 100.
- **after** (string or null) - Optional - Default: null.
- **before** (string or null) - Optional - Default: null.
- **externalSource** (string or null) - Optional.

### Authorizations
_bearerAuth_

### Responses
#### Success Response (200)
Successful response

#### Response Example
```json
{
  "values": [
    {
      "id": "string",
      "filePath": "string"
    }
  ],
  "pagination": {
    "before": null,
    "after": null
  }
}
```

#### Error Responses
- **400** - Invalid input data
- **401** - Authorization not provided
- **403** - Insufficient access
- **404** - Not found
- **500** - Internal server error
```

--------------------------------

### Relation interpolation with join_sql and dot-notation

Source: https://learn.hex.tech/docs/connect-to-data/semantic-models/semantic-authoring/modeling-specification

Shows how to reference a relation ID inside ${} to get the join alias, and how to use dot-notation to access dimensions on the joined model. The example defines a many_to_one relation and a measure using ${customers.is_premium_tier}.

```yaml
relations:
  - id: customers
    type: many_to_one
    # reference the join alias
    join_sql: customer_id = ${customers}.id

measures:
  - id: adjusted_revenue
    # reference a dimension on `customers`
    # let's assume premium tier users get a 10% discount
    func_sql: SUM(IF(${customers.is_premium_tier}, price * 0.9, price))
```

--------------------------------

### Install Looker migration skill with npx

Source: https://learn.hex.tech/docs/migrate-to-hex/migrate-from-looker

Install the Looker migration skill using npx. Requires the Hex CLI and Team/Enterprise plans.

```bash
npx skills add hex-inc/hex-skills --skill looker-migration
```
Tokens:
Raw