at_client_sdk

<a href="https://atsign.com#gh-light-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2022/05/atsign-logo-horizontal-color2022.svg#gh-light-mode-only" alt="The Atsign Foundation"></a><a href="https://atsign.com#gh-dark-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2023/08/atsign-logo-horizontal-reverse2022-Color.svg#gh-dark-mode-only" alt="The Atsign Foundation"></a>

[![GitHub License](https://img.shields.io/badge/license-BSD3-blue.svg)](./LICENSE)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/at_client_sdk/badge)](https://securityscorecards.dev/viewer/?uri=github.com/atsign-foundation/at_client_sdk&sort_by=check-score&sort_direction=desc)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8098/badge)](https://www.bestpractices.dev/projects/8098)

# at_client_sdk

The main repository for libraries used to build applications on the
Atsign Platform. Three categories: SDKs, libraries, and Flutter
widgets.

## SDKs

[![Build Status](https://github.com/atsign-foundation/at_client_sdk/actions/workflows/at_client_sdk.yaml/badge.svg?branch=trunk)](https://github.com/atsign-foundation/at_client_sdk/actions/workflows/at_client_sdk.yaml)

An app depends on its one platform package and imports only that; the
[SDK shape](./docs/sdk-shape.md) explains the layers.

- [at_client_cli](./packages/at_client_cli): the platform package for
  every native Dart program that isn't Flutter — command-line tools,
  daemons, servers and IoT devices. `CLIBase` turns a program's flags into
  an online `AtClient`, `CliKeys` keeps its keyfile and store, and the
  `at_activate` and `at_register` tools register, activate and enrol
  atSigns.
- [at_client_flutter](./packages/at_client_flutter): the platform package
  for Flutter apps on mobile and desktop. Adds onboarding and
  authentication dialogs and device-keychain storage. Flutter web is not a
  supported target.
- [at_client](./packages/at_client): the platform-neutral core both
  re-export. Owns the whole atSign lifecycle — `Atsign('@alice').open`,
  `.activate` and `.enroll` hand back an `AtClient` — as well as
  collections, sync, notifications and encryption. A program imports it
  directly only when it supplies every dependency itself.

## Libraries

[![Build Status](https://github.com/atsign-foundation/at_client_sdk/actions/workflows/at_libraries.yaml/badge.svg?branch=trunk)](https://github.com/atsign-foundation/at_client_sdk/actions/workflows/at_libraries.yaml)

Dart libraries for building Atsign Platform applications. All are
published on
[pub.dev](https://pub.dev/publishers/atsign.org/packages).

- [at_auth](./packages/at_auth): the protocol layer under
  `at_client`'s lifecycle verbs: CRAM activation, the APKAM
  enrollment handshakes, the `.atKeys` key stores and the registrar
  client. Applications reach it through `at_client`.
- [at_chops](./packages/at_chops): cryptographic and hashing
  operations (