40 lines
965 B
Markdown
40 lines
965 B
Markdown
# KeePass TypeScript Library
|
|
|
|
A small TypeScript library for working with KeePass `.kdbx` databases.
|
|
|
|
## Status
|
|
|
|
This branch is a fresh start.
|
|
The runtime implementation is being rebuilt in TypeScript, and `pykeepass` is used only as a compatibility reference during development.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { openKeePassDatabase } from "./src/keepass";
|
|
|
|
const db = openKeePassDatabase("example.kdbx", {
|
|
password: "secret",
|
|
});
|
|
|
|
const entries = await db.listEntries();
|
|
console.log(entries);
|
|
```
|
|
|
|
## API
|
|
|
|
- `openKeePassDatabase(path, options)`
|
|
- `listEntries()`
|
|
- `findEntries(query)`
|
|
- `listGroups()`
|
|
- `createEntry(entry)`
|
|
- `createGroup(group)`
|
|
- `save()`
|
|
- `close()`
|
|
|
|
## Notes
|
|
|
|
- `password` is required when opening a database.
|
|
- `keyFile` is reserved in the public types.
|
|
- The current codebase is intentionally minimal while the native KDBX implementation is rebuilt.
|
|
- Fixtures and compatibility tests can be added or refined as the format implementation grows.
|