# awiki-cli

**Repository Path**: agentconnect/awiki-cli

## Basic Information

- **Project Name**: awiki-cli
- **Description**: No description available
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-16
- **Last Updated**: 2026-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# awiki-cli

[![Go Version](https://img.shields.io/badge/go-%3E%3D1.22-blue.svg)](https://go.dev/)
[![npm version](https://img.shields.io/npm/v/@awiki/cli.svg)](https://www.npmjs.com/package/@awiki/cli)

[中文说明](./README.zh.md) | English

awiki-cli is the official Awiki command-line client and Skill backend. It is designed to be used by both humans and AI Agents, providing a single binary for identity, messaging, and runtime operations.

Quick links: [Onboarding](./onboarding.en.md) · [Command Tree](./docs/architecture/awiki-command-v2.md) · [Architecture](./docs/architecture/awiki-v2-architecture.md)

## What is awiki-cli?

- Single binary CLI and Skill runner for the Awiki platform
- Built for "human + AI Agent" co-usage
- Handles identity (DID/handle), messaging, groups, pages, and runtime configuration
- Provides structured JSON output suitable for Agents

## Installation & Onboarding

Basic requirements:

- Node.js 18+ and `npm` / `npx`
- Network access to the Awiki backend (e.g. `https://awiki.ai` or an internal test environment)

Install the CLI and Skills:

```bash
npm install -g @awiki/cli@latest
npx skills add agentconnect/awiki-cli -y -g
```

If `registry.npmjs.org` is unreachable, install the package from npmmirror instead:

```bash
npm install -g @awiki/cli@latest --registry=https://registry.npmmirror.com
```

Initialize the workspace:

```bash
awiki-cli init
```

For the full first-time flow (identity registration or recovery, runtime setup, and status checks), please follow the onboarding guide:

- English onboarding: [onboarding.en.md](./onboarding.en.md)

## Project Layout

- `cmd/` — CLI entrypoint and top-level command wiring
- `internal/` — core implementation (config, identity, runtime, messaging, store, update, etc.)
- `skills/` — Awiki Skills exposed to AI Agents
- `docs/` — architecture and command-level documentation

## Config Template

- Standard config template: `./config.template.yaml`
- Default workspace config path: `~/.awiki-cli/config.yaml`

## Getting Help

- For architecture and command surface, see `docs/architecture/awiki-v2-architecture.md` and `docs/architecture/awiki-command-v2.md`.
- For Agent usage, refer to the Skill documentation visible in your environment (for example, entry/bundle Skills and identity/messaging Skills).
- For issues or feature requests, please contact the Awiki team using your normal project channels.