> 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

JSONexus is a lightweight and flexible database solution designed for modern applications. It provides a simple and intuitive way to store, query, and manipulate data using JSON documents.

### 1. Installation

Follow the [installation guide](/jsonexus/installation-guide.md) 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('data/db.json')
```

JSONexus auto-creates any missing parent directories, so `data/db.json` works even without a `data/` folder. Writes are atomic: a temporary file is used and then atomically replaced via `os.replace`, so a crash mid-write never corrupts the database file.

For safe flush/close handling, use the context manager:

```python
with JSONexus('data/db.json') as db:
    db.insert('users', {'name': 'Alice', 'age': 30})
    db.insert('users', {'name': 'Bob', 'age': 25})
# On exit the database is flushed and closed
```

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

See [Operations](/jsonexus/operations.md) for the full method reference.