Skip to content

Commit 5de9832

Browse files
committed
omit cre.yaml from version control note
1 parent 7e9e034 commit 5de9832

5 files changed

Lines changed: 36 additions & 21 deletions

File tree

src/content/cre/account/cli-login.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "Logging in with the CLI"
55
metadata:
66
description: "Learn how to log in to the CRE CLI: authenticate through your browser, complete 2FA verification, and start using CLI commands."
77
datePublished: "2025-11-04"
8-
lastModified: "2026-03-26"
8+
lastModified: "2026-05-22"
99
---
1010

1111
import { Aside, ClickToZoom } from "@components"
@@ -81,4 +81,9 @@ Login completed successfully
8181

8282
Your CLI session is authenticated and ready to use.
8383

84-
In the terminal, the CLI may show **“Fetching user context…”** while it downloads your organization’s tenant configuration from the platform. It then writes **`~/.cre/context.yaml`** (registry manifest: vault gateway URL, registries, secrets auth flows, and related fields). That file is separate from your credentials file (`cre.yaml`). For details and a sanitized example, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
84+
In the terminal, the CLI may show **“Fetching user context…”** while it downloads your organization’s tenant configuration from the platform. It then writes **`~/.cre/context.yaml`** (registry manifest: vault gateway URL, registries, secrets auth flows, and related fields). That file is separate from your credentials file (`~/.cre/cre.yaml`). For details and a sanitized example, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
85+
86+
{/* prettier-ignore */}
87+
<Aside type="caution" title="Do not commit cre.yaml">
88+
**`~/.cre/cre.yaml`** contains your session credentials. Keep it in `~/.cre/` on your local machine only—never commit it to version control or copy it into a project repository.
89+
</Aside>

src/content/cre/account/managing-auth.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "Managing Authentication"
55
metadata:
66
description: "Manage your CRE CLI sessions: check if you're logged in, handle expired sessions, and securely log out when needed."
77
datePublished: "2025-11-04"
8-
lastModified: "2026-03-26"
8+
lastModified: "2026-05-22"
99
---
1010

1111
import { Aside } from "@components"
@@ -18,7 +18,7 @@ To authenticate your CLI with your CRE account, use the `cre login` command. Thi
1818

1919
For detailed login instructions, see the [Logging in with the CLI](/cre/account/cli-login) guide.
2020

21-
Browser login stores **`~/.cre/cre.yaml`** (credentials) and **`~/.cre/context.yaml`** (cached **tenant context**: registry manifest from the platform, including vault gateway URL and related settings). **`cre logout`** removes both. For a full description and a sample `context.yaml` shape, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
21+
Browser login stores **`~/.cre/cre.yaml`** (credentials) and **`~/.cre/context.yaml`** (cached **tenant context**: registry manifest from the platform, including vault gateway URL and related settings). **`cre logout`** removes both. Do not commit **`~/.cre/cre.yaml`** to version control. For a full description and a sample `context.yaml` shape, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
2222

2323
## API key authentication
2424

src/content/cre/llms-full-go.txt

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7084,7 +7084,7 @@ Once your account is created:
70847084

70857085
# Logging in with the CLI
70867086
Source: https://docs.chain.link/cre/account/cli-login
7087-
Last Updated: 2026-03-26
7087+
Last Updated: 2026-05-22
70887088

70897089
To deploy and manage workflows with the CRE CLI, you need to authenticate your CLI session with your CRE account. This guide walks you through the browser-based login process.
70907090

@@ -7145,13 +7145,18 @@ Login completed successfully
71457145

71467146
Your CLI session is authenticated and ready to use.
71477147

7148-
In the terminal, the CLI may show **“Fetching user context…”** while it downloads your organization’s tenant configuration from the platform. It then writes **`~/.cre/context.yaml`** (registry manifest: vault gateway URL, registries, secrets auth flows, and related fields). That file is separate from your credentials file (`cre.yaml`). For details and a sanitized example, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
7148+
In the terminal, the CLI may show **“Fetching user context…”** while it downloads your organization’s tenant configuration from the platform. It then writes **`~/.cre/context.yaml`** (registry manifest: vault gateway URL, registries, secrets auth flows, and related fields). That file is separate from your credentials file (`~/.cre/cre.yaml`). For details and a sanitized example, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
7149+
7150+
7151+
<Aside type="caution" title="Do not commit cre.yaml">
7152+
**`~/.cre/cre.yaml`** contains your session credentials. Keep it in `~/.cre/` on your local machine only—never commit it to version control or copy it into a project repository.
7153+
</Aside>
71497154

71507155
---
71517156

71527157
# Managing Authentication
71537158
Source: https://docs.chain.link/cre/account/managing-auth
7154-
Last Updated: 2026-03-26
7159+
Last Updated: 2026-05-22
71557160

71567161
This guide covers how to manage your CLI authentication, including browser-based login, API key authentication, checking your status, handling session expiration, and logging out.
71577162

@@ -7161,7 +7166,7 @@ To authenticate your CLI with your CRE account, use the `cre login` command. Thi
71617166

71627167
For detailed login instructions, see the [Logging in with the CLI](/cre/account/cli-login) guide.
71637168

7164-
Browser login stores **`~/.cre/cre.yaml`** (credentials) and **`~/.cre/context.yaml`** (cached **tenant context**: registry manifest from the platform, including vault gateway URL and related settings). **`cre logout`** removes both. For a full description and a sample `context.yaml` shape, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
7169+
Browser login stores **`~/.cre/cre.yaml`** (credentials) and **`~/.cre/context.yaml`** (cached **tenant context**: registry manifest from the platform, including vault gateway URL and related settings). **`cre logout`** removes both. Do not commit **`~/.cre/cre.yaml`** to version control. For a full description and a sample `context.yaml` shape, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
71657170

71667171
## API key authentication
71677172

@@ -8387,7 +8392,7 @@ The typical workflow development process uses these commands in sequence:
83878392

83888393
# Authentication Commands
83898394
Source: https://docs.chain.link/cre/reference/cli/authentication
8390-
Last Updated: 2026-05-08
8395+
Last Updated: 2026-05-22
83918396

83928397
The CRE CLI supports two authentication methods:
83938398

@@ -8483,8 +8488,8 @@ In a CI/CD pipeline, configure `CRE_API_KEY` as a secret environment variable in
84838488
After a successful browser login — and when using an API key for commands that load credentials — the CLI stores **tenant context** at **`~/.cre/context.yaml`**. This file comes from the platform’s **`getTenantConfig`** data: a **registry manifest** for your organization so the CLI knows your CRE environment layout (for example vault gateway URL, registries, and allowed secrets auth flows per registry). Values are grouped under your CRE environment name (such as `PRODUCTION`).
84848489

84858490

8486-
<Aside type="note" title="Credentials vs tenant context">
8487-
**`cre.yaml`** holds authentication tokens for your session. **`context.yaml`** holds **tenant configuration** returned by the platform, not secrets. **`cre logout`** removes both files from your machine.
8491+
<Aside type="caution" title="Keep credential files out of version control">
8492+
**`~/.cre/cre.yaml`** holds authentication tokens for your session. Do not commit it to version control or copy it into your project repository—it belongs only in `~/.cre/` on your local machine. If you copy `cre.yaml` elsewhere, add it to `.gitignore` so it is not tracked. **`context.yaml`** holds **tenant configuration** returned by the platform, not secrets. **`cre logout`** removes both files from your machine.
84888493
</Aside>
84898494

84908495
The following example is **illustrative** only; your registries, addresses, and flow lists depend on your organization and environment.

src/content/cre/llms-full-ts.txt

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6636,7 +6636,7 @@ Once your account is created:
66366636

66376637
# Logging in with the CLI
66386638
Source: https://docs.chain.link/cre/account/cli-login
6639-
Last Updated: 2026-03-26
6639+
Last Updated: 2026-05-22
66406640

66416641
To deploy and manage workflows with the CRE CLI, you need to authenticate your CLI session with your CRE account. This guide walks you through the browser-based login process.
66426642

@@ -6697,13 +6697,18 @@ Login completed successfully
66976697

66986698
Your CLI session is authenticated and ready to use.
66996699

6700-
In the terminal, the CLI may show **“Fetching user context…”** while it downloads your organization’s tenant configuration from the platform. It then writes **`~/.cre/context.yaml`** (registry manifest: vault gateway URL, registries, secrets auth flows, and related fields). That file is separate from your credentials file (`cre.yaml`). For details and a sanitized example, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
6700+
In the terminal, the CLI may show **“Fetching user context…”** while it downloads your organization’s tenant configuration from the platform. It then writes **`~/.cre/context.yaml`** (registry manifest: vault gateway URL, registries, secrets auth flows, and related fields). That file is separate from your credentials file (`~/.cre/cre.yaml`). For details and a sanitized example, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
6701+
6702+
6703+
<Aside type="caution" title="Do not commit cre.yaml">
6704+
**`~/.cre/cre.yaml`** contains your session credentials. Keep it in `~/.cre/` on your local machine only—never commit it to version control or copy it into a project repository.
6705+
</Aside>
67016706

67026707
---
67036708

67046709
# Managing Authentication
67056710
Source: https://docs.chain.link/cre/account/managing-auth
6706-
Last Updated: 2026-03-26
6711+
Last Updated: 2026-05-22
67076712

67086713
This guide covers how to manage your CLI authentication, including browser-based login, API key authentication, checking your status, handling session expiration, and logging out.
67096714

@@ -6713,7 +6718,7 @@ To authenticate your CLI with your CRE account, use the `cre login` command. Thi
67136718

67146719
For detailed login instructions, see the [Logging in with the CLI](/cre/account/cli-login) guide.
67156720

6716-
Browser login stores **`~/.cre/cre.yaml`** (credentials) and **`~/.cre/context.yaml`** (cached **tenant context**: registry manifest from the platform, including vault gateway URL and related settings). **`cre logout`** removes both. For a full description and a sample `context.yaml` shape, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
6721+
Browser login stores **`~/.cre/cre.yaml`** (credentials) and **`~/.cre/context.yaml`** (cached **tenant context**: registry manifest from the platform, including vault gateway URL and related settings). **`cre logout`** removes both. Do not commit **`~/.cre/cre.yaml`** to version control. For a full description and a sample `context.yaml` shape, see [Tenant context cache](/cre/reference/cli/authentication#tenant-context-cache).
67176722

67186723
## API key authentication
67196724

@@ -8000,7 +8005,7 @@ The typical workflow development process uses these commands in sequence:
80008005

80018006
# Authentication Commands
80028007
Source: https://docs.chain.link/cre/reference/cli/authentication
8003-
Last Updated: 2026-05-08
8008+
Last Updated: 2026-05-22
80048009

80058010
The CRE CLI supports two authentication methods:
80068011

@@ -8096,8 +8101,8 @@ In a CI/CD pipeline, configure `CRE_API_KEY` as a secret environment variable in
80968101
After a successful browser login — and when using an API key for commands that load credentials — the CLI stores **tenant context** at **`~/.cre/context.yaml`**. This file comes from the platform’s **`getTenantConfig`** data: a **registry manifest** for your organization so the CLI knows your CRE environment layout (for example vault gateway URL, registries, and allowed secrets auth flows per registry). Values are grouped under your CRE environment name (such as `PRODUCTION`).
80978102

80988103

8099-
<Aside type="note" title="Credentials vs tenant context">
8100-
**`cre.yaml`** holds authentication tokens for your session. **`context.yaml`** holds **tenant configuration** returned by the platform, not secrets. **`cre logout`** removes both files from your machine.
8104+
<Aside type="caution" title="Keep credential files out of version control">
8105+
**`~/.cre/cre.yaml`** holds authentication tokens for your session. Do not commit it to version control or copy it into your project repository—it belongs only in `~/.cre/` on your local machine. If you copy `cre.yaml` elsewhere, add it to `.gitignore` so it is not tracked. **`context.yaml`** holds **tenant configuration** returned by the platform, not secrets. **`cre logout`** removes both files from your machine.
81018106
</Aside>
81028107

81038108
The following example is **illustrative** only; your registries, addresses, and flow lists depend on your organization and environment.

src/content/cre/reference/cli/authentication.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "Authentication Commands"
55
metadata:
66
description: "Manage your CLI authentication: browser-based login, API key authentication for CI/CD, and session management commands."
77
datePublished: "2025-11-04"
8-
lastModified: "2026-05-08"
8+
lastModified: "2026-05-22"
99
---
1010

1111
import { Aside } from "@components"
@@ -104,8 +104,8 @@ In a CI/CD pipeline, configure `CRE_API_KEY` as a secret environment variable in
104104
After a successful browser login — and when using an API key for commands that load credentials — the CLI stores **tenant context** at **`~/.cre/context.yaml`**. This file comes from the platform’s **`getTenantConfig`** data: a **registry manifest** for your organization so the CLI knows your CRE environment layout (for example vault gateway URL, registries, and allowed secrets auth flows per registry). Values are grouped under your CRE environment name (such as `PRODUCTION`).
105105

106106
{/* prettier-ignore */}
107-
<Aside type="note" title="Credentials vs tenant context">
108-
**`cre.yaml`** holds authentication tokens for your session. **`context.yaml`** holds **tenant configuration** returned by the platform, not secrets. **`cre logout`** removes both files from your machine.
107+
<Aside type="caution" title="Keep credential files out of version control">
108+
**`~/.cre/cre.yaml`** holds authentication tokens for your session. Do not commit it to version control or copy it into your project repository—it belongs only in `~/.cre/` on your local machine. If you copy `cre.yaml` elsewhere, add it to `.gitignore` so it is not tracked. **`context.yaml`** holds **tenant configuration** returned by the platform, not secrets. **`cre logout`** removes both files from your machine.
109109
</Aside>
110110

111111
The following example is **illustrative** only; your registries, addresses, and flow lists depend on your organization and environment.

0 commit comments

Comments
 (0)