> For the complete documentation index, see [llms.txt](https://docs.keyshade.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keyshade.io/cli/init.md).

# Init

The `init` command is used to initialize your project to tap into the live updates from our platform. This command creates a `keyshade.json` file in your project root. This file contains the following information:

## Usage

```bash
keyshade init [options]
```

## Options

These are the commands supported by the `init` command:

### `-w, --workspace <workspace>`

The workspace name whose updates you want to tap into.

### `-p, --project <project>`

The project name whose updates you want to tap into. Note that this project must be under the specified workspace.

### `-e, --environment <environment>`

The environment name whose updates you want to tap into. Note that this environment must be under the specified project.

### `-k, --private-key <key>`

The private key for the project+environment pair. This key is used to decrypt the secrets that are sent to your application.

### `-o, --overwrite`

This flag is used to overwrite the existing `keyshade.json` file in the project root. The default is `false`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.keyshade.io/cli/init.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.