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

# etherlime init

## Syntax

```
etherlime init [output] [zk]
```

Parameters:

* `output` - \[Optional] Defines the way that the logs are shown.

  Choices: `none` - silences the output of logs, `normal` - see

  verbose logs in the console and `structured` - structured output in

  a file meant for inter program communication.
* `zk` - \[Optional] Defines whether to include in project a zk-proof

  folder with primary ready to use circuit for compiling. Defaults to

  `false`.

Running this command will install `etherlime` in the directory you've run it and will create `deployment` directory with `deploy.js` prepared for you to use. You can use this file to write your deployment procedure. It also create `test` directory where you can write your tests. It comes with an `exampleTest.js` file which you can use as a start point. The init command generate and `package.json` for you which you can use for your npm modules.


---

# 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:

```
GET https://etherlime.gitbook.io/etherlime/developer-documentation/etherlime-cli/init.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
