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

# Getting Started

### 1. Installation

Follow the[ installation guide](#id-1.-installation) to install JSONexus in your Python environment.

### 2. Import JSONexus

In your Python code, import JSONexus to start using it:

```python
from jsonexus import JSONexus
```

### 3. Create a Database

Create a new instance of JSONexus database by providing the name of the JSON file to store the database:

```python
db = JSONexus('example_db.json')
```

### 4. Perform Database Operations

Perform CRUD (Create, Read, Update, Delete) operations using JSON-based data:

* **Insert:** Add a new record to the database.
* **Find:** Find records in the database that match the specified query.
* **Delete:** Delete records from the database that match the specified query.
* **Update:** Update records in the database that match the specified query.


---

# 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://jsonexus.gitbook.io/jsonexus/getting-started.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.