HipHops Hook - Client Libraries

Official client libraries for HipHops Hook, making it easy to integrate Hook into your applications across different programming languages and platforms.

🚀 Quick Start

JavaScript/TypeScript

npm install @hiphops/hook

import { license } from "@hiphops/hook";

// Get license information
const getLicenseInfo = async () => {
  try {
    const info = await license();
    if (info.verified) {
      console.log("License is valid:", info.license);
    } else {
      console.warn("License verification failed:", info.verify_failures);
    }
    console.log("License info:", info);
    return info;
  } catch (error) {
    console.error("Error getting license info:", error);
  }
};

getLicenseInfo();

📚 Available Clients

JavaScript/TypeScript Client

The JavaScript client provides a robust interface for working with Hook in Node.js and browser environments.

• TypeScript Support: Full TypeScript definitions included
• Cross-Platform: Works on macOS, Linux, and Windows
• Automatic Binary Management: Handles Hook binary lifecycle automatically
• Promise-Based: Modern async/await support

📖 JavaScript Client Documentation

Coming Soon

• Python Client: Python bindings for Hook integration
• REST API: Direct HTTP interface for any language

📝 Examples

Find ready-to-run examples for each client in the examples/ directory:

• 📦 JavaScript/TypeScript: examples/js

🗂️ Browse all examples

🛠 Development

Architecture

This repository contains only the client libraries and public-facing documentation. The core Hook binary is automatically packaged with these clients during the release process.

Contributing

We welcome contributions to the client libraries! Please:

1. Fork this repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

Local Development

# Clone the repository
git clone https://github.com/hiphops/hook.git
cd hook

# JavaScript client development
cd clients/js
npm install
npm test

📦 Release Process

Client libraries are automatically built and published when new versions of Hook are released. The release process:

1. Core Hook binary is built and signed
2. Client libraries are updated with new binaries
3. Packages are published to respective package managers (npm, PyPI, etc.)
4. GitHub releases are created with binaries and changelogs

🔧 System Requirements

• Node.js: 18+ (for JavaScript client)
• Python: 3.8+ (for Python client, when available)
• Operating Systems: macOS, Linux, Windows

🆘 Support

• Documentation: Check the client-specific README files
• Issues: Report bugs and feature requests in this repository
• Discussions: Join community discussions in the GitHub Discussions tab

---

Note: This is the public repository for Hook client libraries. For enterprise licensing and private deployments, contact the HipHops team.