> For the complete documentation index, see [llms.txt](https://docs.aeternity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aeternity.com/developer-documentation/aeproject/docs/index.md). # Quick Start ## Requirements In order to have AEproject working you must have installed the following: ``` nodejs >= 18 docker ``` **Note:** on windows WSL 2 must be used ## Install ``` npm install -g @aeternity/aeproject ``` ## Init a project ``` aeproject init [folder] ``` This will create the project scaffold with an example contract including tests as well as a sample deployment script inside the specified folder. If no folder is specified the artifacts will be initialized in the current directory. Further explained in [Initialization Documentation](/developer-documentation/aeproject/docs/cli/init.md). ## Running a local environment ``` aeproject env ``` This will run a local æternity network in dev-mode (node, compiler and nginx-proxy). To stop an already spawned local environment use `aeproject env --stop` Further explained in [Environment Documentation](/developer-documentation/aeproject/docs/cli/env.md). ## Testing ``` aeproject test ``` This will run the tests located in `./test` folder. Further explained in [Testing Documentation](/developer-documentation/aeproject/docs/cli/test.md). ## Help ``` aeproject help ``` Run this command to give you all possible commands of `aeproject` with help and info ## Version ``` aeproject --version ``` Running this command will give you the current installed `aeproject` version --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.aeternity.com/developer-documentation/aeproject/docs/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.