# AEproject

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

**AEproject** is an æternity framework which helps with setting up a project to develop and test [Sophia Smart Contracts](https://github.com/aeternity/aesophia). It provides commands to spin up a local environment as well as utilities for compiling and testing Sophia Smart Contracts. The initial scaffold provides an example contract & corresponding tests.

## Install

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

## Documentation

* [Quick Start](/developer-documentation/aeproject/docs/index.md)
* [Project Initialization](/developer-documentation/aeproject/docs/cli/init.md)
* [Local Environment](/developer-documentation/aeproject/docs/cli/env.md)
* [Unit Testing](/developer-documentation/aeproject/docs/cli/test.md)
* [AEproject Library](/developer-documentation/aeproject/docs/lib.md)
* [Migration from 3.x.x to 4.x.x](/developer-documentation/aeproject/docs/migration-from-3.x.x-to-4.x.x.md)
* [Migration from 4.x.x to 5.x.x](/developer-documentation/aeproject/docs/migration-from-4.x.x-to-5.x.x.md)
* [Upcoming Version Support](/developer-documentation/aeproject/docs/next-support.md)

## Release Process

1. merge the release please PR
   * as `@aeternity/aeproject` has a dependency on itself as library, the CI run before publishing to npm after merging might fail
2. build locally and publish
   * checkout latest `origin/main` including the merged release please PR, ensure no local changes
   * publish to npm using `npm publish` (does automatically clean-build, may require login if not already)


---

# Agent Instructions: 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://docs.aeternity.com/developer-documentation/aeproject.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.