ms-family-safety
v1.0.1
Published
Microsoft Family Safety API client
Readme
ms-family-safety
Unofficial TypeScript client for the Microsoft Family Safety API — usable as a library or CLI
⚠️ Disclaimer: This project is not affiliated with, endorsed by, or associated with Microsoft Corporation in any way. Microsoft Family Safety is a trademark of Microsoft Corporation. Use of the Microsoft Family Safety name and logo is solely for identification purposes. This is an independent, community-driven project developed through reverse engineering of the public API.
This project is intended for personal and research use only. It must not be used for commercial purposes, sold, or otherwise financially exploited.
Users authenticate using their own Microsoft account credentials. No credentials are stored or transmitted by this library beyond what is necessary to call the API on behalf of the authenticated user. The
CLIENT_IDused is publicly embedded in the official Microsoft Family Safety Android app and is reused solely to enable OAuth authentication on behalf of the user — no impersonation of Microsoft or its services is intended.Note to Microsoft employees: If this repository raises any concerns regarding intellectual property, terms of service, or any other matter, please reach out via GitHub Issues or directly to @ludufre. I will promptly take down or modify the repository upon request — no legal action necessary.
Maintainers
| Maintainer | GitHub | Social | LinkedIn | | ---------------------- | ------------------------------------- | --------------------------------- | ------------------------------------------------------------------ | | Luan Freitas (ludufre) | ludufre | @ludufre | Luan Freitas |
Installation
Requires Node.js ≥ 18.
# as a library
npm install ms-family-safety
# as a global CLI
npm install -g ms-family-safety
# or using pnpm
pnpm add ms-family-safety
pnpm add -g ms-family-safetyDocumentation
- CLI Reference — authentication, all commands and options
- Library API —
FamilySafetyclass, methods, and low-level API - Types Reference — types, interfaces, enums, and errors
Building from source
pnpm install
pnpm build # outputs to dist/