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

# AEproject

[![npm version](https://badge.fury.io/js/%40aeternity%2Faeproject.svg)](https://badge.fury.io/js/%40aeternity%2Faeproject)

**AEproject** is an aeternity framework which helps with setting up a project to develop Sophia Smart Contracts. It provides commands to spin up a local environment as well as compilation and deployment of Sophia Smart Contracts. The initial scaffold provides an example contract, corresponding tests and an example deploy script.

## Install

```
npm i -g @aeternity/aeproject
```

## Documentation

* [Quick Start](/aeproject/doc/developer-documentation/getting-started.md)
* [AEproject CLI](/aeproject/doc/developer-documentation/aeproject-cli.md)
  * [Installing and Help](/aeproject/doc/developer-documentation/aeproject-cli/install.md)
  * [aeproject init](/aeproject/doc/developer-documentation/aeproject-cli/init.md)
  * [aeproject env](/aeproject/doc/developer-documentation/aeproject-cli/env.md)
  * [aeproject node](/aeproject/doc/developer-documentation/aeproject-cli/node.md)
  * [aeproject compiler](/aeproject/doc/developer-documentation/aeproject-cli/compiler.md)
  * [aeproject compile](/aeproject/doc/developer-documentation/aeproject-cli/compile.md)
  * [aeproject deploy](/aeproject/doc/developer-documentation/aeproject-cli/deploy.md)
  * [aeproject test](/aeproject/doc/developer-documentation/aeproject-cli/testing.md)
  * [aeproject inspect](/aeproject/doc/developer-documentation/aeproject-cli/tx-inspect.md)
  * [aeproject compatibility](/aeproject/doc/developer-documentation/aeproject-cli/compatibility.md)
* [Migration from version 2.x.x to 3.x.x (after Iris hardfork)](/aeproject/doc/developer-documentation/migration-from-2.x.x-to-3.x.x.md)
* [License](/aeproject/doc/developer-documentation/licence.md)