amagi 0.1.4

Rust SDK, CLI, and Web API service skeleton for multi-platform social web adapters.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# amagi

Chinese README: [`README.zh-CN.md`](README.zh-CN.md)

`amagi` is a Rust SDK, CLI, and JSON Web API service for multi-platform social web adapters.

## What It Does

- Run CLI tasks against Bilibili, Douyin, Kuaishou, Twitter/X, and Xiaohongshu
- Start a local JSON Web API with `amagi serve`
- Reuse the same capability as a Rust crate with feature flags

## Quick Start

Install the latest release:

Linux/macOS:

```bash
curl -fsSL https://raw.githubusercontent.com/bandange/amagi-rs/main/scripts/install.sh | bash
```

PowerShell:

```powershell
irm https://raw.githubusercontent.com/bandange/amagi-rs/main/scripts/install.ps1 | iex
```

Use proxy mode:

Linux/macOS:

```bash
curl -fsSL https://gh-proxy.com/https://raw.githubusercontent.com/bandange/amagi-rs/main/scripts/install.sh | bash -s -- --proxy
```

PowerShell:

```powershell
& ([scriptblock]::Create((irm "https://gh-proxy.com/https://raw.githubusercontent.com/bandange/amagi-rs/main/scripts/install.ps1"))) -Proxy
```

Verify:

```bash
amagi --version
```

Common examples:

```bash
amagi run douyin video-work <aweme_id>
amagi run bilibili emoji-list
amagi run twitter user-profile <screen_name>
amagi serve --host 127.0.0.1 --port 4567
```

For install, update, uninstall, and shell integration details, see the [installation guide](docs/installation/README.md).

## Run From Source

If you do not want to install the binary, run it directly in the repository. This requires a local Rust toolchain.

```bash
cargo run -- run
cargo run -- run douyin video-work <aweme_id>
cargo run -- serve --host 127.0.0.1 --port 4567
```

## Configuration

Configuration is loaded in this order:

1. the user-level dotenv file
2. the current directory `.env`

User-level dotenv path:

- Linux/macOS: `~/.config/amagi/.env`
- Windows: `%APPDATA%\\amagi\\.env`

Useful files and variables:

- [`.env.example`](.env.example)
- `AMAGI_USER_ENV_FILE`
- `AMAGI_DOUYIN_COOKIE`
- `AMAGI_BILIBILI_COOKIE`
- `AMAGI_KUAISHOU_COOKIE`
- `AMAGI_TWITTER_COOKIE`
- `AMAGI_XIAOHONGSHU_COOKIE`
- `AMAGI_HOST`
- `AMAGI_PORT`

For the full environment and CLI option list, see the [CLI reference](docs/reference/cli-reference.md).

## Crate Features

Default features: `client`, `cli`, `server`

Optional features:

- `catalog`: static catalog and route metadata only
- `client`: Rust client types and upstream fetchers
- `cli`: command-line runtime
- `server`: Axum-based HTTP service

Example:

```toml
amagi = { version = "0.1.4", default-features = false, features = ["client"] }
```

## Documentation

- Installation guide: [docs/installation/README.md](docs/installation/README.md)
- CLI reference: [docs/reference/cli-reference.md](docs/reference/cli-reference.md)
- SDK reference: [docs/reference/sdk-reference.md](docs/reference/sdk-reference.md)
- Web API reference: [docs/reference/web-api-reference.md](docs/reference/web-api-reference.md)
- API catalog reference: [docs/reference/api-catalog-reference.md](docs/reference/api-catalog-reference.md)

Chinese documentation:

- Installation guide: [docs/installation/README.zh-CN.md](docs/installation/README.zh-CN.md)
- CLI reference: [docs/reference/cli-reference.zh-CN.md](docs/reference/cli-reference.zh-CN.md)
- SDK reference: [docs/reference/sdk-reference.zh-CN.md](docs/reference/sdk-reference.zh-CN.md)
- Web API reference: [docs/reference/web-api-reference.zh-CN.md](docs/reference/web-api-reference.zh-CN.md)
- API catalog reference: [docs/reference/api-catalog-reference.zh-CN.md](docs/reference/api-catalog-reference.zh-CN.md)