@tekmemo/fs

@tekmemo/fs

Purpose

Filesystem adapter. Node.js adapter for the canonical .tekmemo/ directory layout.

Install

pnpm add @tekmemo/fs

Quick start

import { createFileSystemMemoryStore } from "@tekmemo/fs";

const store = createFileSystemMemoryStore({ rootDir: process.cwd() });
const core = await store.readCoreMemory();

Boundary

This package owns its package-level contract only. It does not own TekMemo Cloud billing, dashboards, tenancy, hosted database storage, or provider secrets unless explicitly stated by its package name.

For hosted memory, use @tekmemo/cloud-client. For local file-backed memory, use tekmemo with @tekmemo/fs. For MCP tools, use @tekmemo/mcp-server.

Scripts

pnpm --filter @tekmemo/fs typecheck
pnpm --filter @tekmemo/fs test:run
pnpm --filter @tekmemo/fs build
pnpm --filter @tekmemo/fs lint:package

Docs

• Package docs: https://docs.tekmemo.dev/packages/
• Examples: https://docs.tekmemo.dev/examples/
• Repository: https://github.com/tekbreed/tekmemo

Publishing metadata

• npm package: @tekmemo/fs
• publish visibility: public
• runtime format: dual ESM/CJS
• ESM output: dist/**/*.mjs + dist/**/*.d.mts
• CJS output: dist/**/*.cjs + dist/**/*.d.cts
• package contents: dist and README.md
• package boundary: hosted cloud calls must go through @tekmemo/cloud-client unless this package is @tekmemo/cloud-client itself.

Publish readiness

Before publishing this package, run:

pnpm --filter @tekmemo/fs release:check

The package-level check builds dist/, runs TypeScript and tests, runs publint, and performs npm pack --dry-run. Publish from CI with Changesets and npm trusted publishing/provenance after the root release preflight passes.

License

MIT.