# @imqueue

> RPC over an inter-communication messaging queue for service-oriented Node.js & TypeScript back-ends. Self-describing services generate their own strongly-typed clients — no hand-written client code, no service discovery, no load balancer.

@imqueue is an open-source framework (GPL-3.0). Core packages: @imqueue/core (reliable message queue over Redis), @imqueue/rpc (typed RPC with automatic client generation), @imqueue/cli (scaffolding and orchestration of services). Commercial licensing and support for closed-source products: https://imqueue.com

## Getting Started
- [Getting Started](https://imqueue.org/get-started/): Install @imqueue and ship your first Node & TypeScript service in minutes — the shortest quickstart for building message-queue RPC microservices.
- [Introduction](https://imqueue.org/intro/): @imqueue is an inter-communication messaging queue framework for service-oriented Node & TypeScript back-ends. Build microservices fast and focus on functionality — @imqueue handles the low-level messaging, discovery and load-balancing.

## Tutorial
- [API Integration](https://imqueue.org/tutorial/api-service/): Put a GraphQL API in front of your services — @imqueue works beautifully with GraphQL.
- [Auth Service](https://imqueue.org/tutorial/auth-service/): Add an Auth service that talks to the User service to log users in and verify them — your first inter-service communication.
- [Deployment](https://imqueue.org/tutorial/deployment/): Ship your services: per-service Docker images, environment-based configuration, and horizontal scaling for any load.
- [Introduction](https://imqueue.org/tutorial/): A step-by-step guide to building back-end services for a car-washing web application with @imqueue — for those who prefer to learn by example.
- [Domain Services](https://imqueue.org/tutorial/other-services/): Add the remaining domain services — Car and Time-Table — and choose how their typed clients are generated.
- [User Service — your first service](https://imqueue.org/tutorial/user-service/): Create your first @imqueue service — the User service — and expose typed methods that other services can call.

## CLI Guide
- [Clients & Versioning](https://imqueue.org/cli/clients-and-versioning/): @imqueue/cli client generation and versioning: imq client generate for typed RPC clients from a running service, and imq service update-version to release across many services.
- [Configuration](https://imqueue.org/cli/configuration/): @imqueue/cli configuration: the flag → .imqrc.json → global config → prompt → default precedence, the v4 schema, secrets handling, HTTPS vs SSH push, and env var reference.
- [Creating Services](https://imqueue.org/cli/creating-services/): Create @imqueue services with imq service create: the four provider axes, every option, --dry-run previews, the full create pipeline, failure & rollback, and non-interactive/CI usage.
- [Custom Templates](https://imqueue.org/cli/custom-templates/): Author @imqueue/cli templates: selecting a template, the v2 imq-template.json manifest, %TOKEN substitution, addon token points, fragment overlays, and writing your own template.
- [Extensibility](https://imqueue.org/cli/extensibility/): Extend @imqueue/cli: the four-axis provider model, environment seams for enterprise/self-hosted hosts, data-driven templates and catalog, and a contributor guide to adding providers.
- [CLI User Guide](https://imqueue.org/cli/): The @imqueue/cli (imq) user manual — a Rapid Application Development tool that scaffolds services, wires VCS/CI/registry providers, generates typed RPC clients and runs a local fleet.
- [Installation](https://imqueue.org/cli/installation/): Install @imqueue/cli globally, verify the imq command, upgrade from 3.x, enable bash & zsh completions, and see which files the CLI creates.
- [Managing Local Services](https://imqueue.org/cli/managing-local-services/): Manage a local @imqueue fleet: imq ctl start/stop/restart/status, combined colour-prefixed logs with imq log, and bulk dependency updates with imq up, including source-level service discovery.
- [Package Catalog](https://imqueue.org/cli/package-catalog/): The @imqueue/cli addon package catalog: adding libraries with --packages, exclusive vs feature groups, what each addon injects, interactive selection, and extending the catalog.
- [Providers](https://imqueue.org/cli/providers/): @imqueue/cli providers: GitHub/GitLab/Bitbucket VCS hosts, GitHub Actions/CircleCI/Travis CI, Docker Hub/Google/AWS ECR/Azure ACR registries, M+N composition, and enterprise/self-hosted overrides.
- [Real-World Scenarios](https://imqueue.org/cli/real-world-scenarios/): @imqueue/cli end-to-end recipes: new service on GitHub/Actions/Docker Hub, GitLab/CircleCI/Google, GitHub Enterprise, running a local fleet, fleet-wide dependency maintenance and coordinated releases.
- [Troubleshooting](https://imqueue.org/cli/troubleshooting/): Troubleshoot @imqueue/cli: prompts hanging in CI, template fetch/SSH issues, git identity and push (Repository not found) failures, enterprise host setup, service discovery, and resetting state.

## Reference
- [API Documentation](https://imqueue.org/api/): Full generated API reference for @imqueue/core and @imqueue/rpc (classes, interfaces, methods, types).
- [Documentation home](https://imqueue.org/docs/): Entry point to all @imqueue documentation.

## Full text
- [llms-full.txt](https://imqueue.org/llms-full.txt): The complete documentation concatenated as a single markdown file for ingestion.

## Commercial
- [Commercial license & support](https://imqueue.com/): Ship @imqueue inside a closed-source product and get SLA-backed support.