Files
software-mansion__argent/README.md
Ignacy Łątka 8dd2621968 docs: cut the README to the essentials (#1082)
The README duplicated the docs site - install prerequisites, a Linux
emulator tuning essay, the full CLI and editor tables - burying what
Argent actually is. 17.4 KB -> 3.5 KB (5.0x), no information lost:
everything cut already lives in the docs, now linked.

| | Before | After |
| --- | --- | --- |
| Size | 217 lines / 17404 chars | 43 lines / 3477 chars |
| Sections | 9 (incl. a ~4500-char Linux emulator section, CLI table,
editors table) | 6 |
| Media | header, 3 ads, showcase gif, SWM logo | unchanged |
| Legal | Privacy + License | unchanged (License verbatim) |

<details>
<summary>Where the removed content lives</summary>

| Removed | Docs page |
| --- | --- |
| Prerequisites, Linux emulator tuning, `--local` team install, manual
install |
[fundamentals/installation](https://docs.swmansion.com/argent/docs/fundamentals/installation)
|
| Supported platforms table |
[fundamentals/supported-platforms](https://docs.swmansion.com/argent/docs/fundamentals/supported-platforms)
|
| CLI reference table |
[reference/cli](https://docs.swmansion.com/argent/docs/reference/cli) |
| Supported editors table |
[reference/editors](https://docs.swmansion.com/argent/docs/reference/editors)
|

Verified: `prettier --check` passes; all five outbound links return 200;
`LICENSE.txt`, `Telemetry.md` and `assets/showcase.gif` exist at the
referenced paths.

No docs changes needed - the docs site already covered every removed
section.
</details>

🤖 Generated with [Claude Code](https://claude.com/claude-code)

https://claude.ai/code/session_01YNGjiLLCf4cg3LXx4SCeUC

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-09 14:37:59 +02:00

44 lines
3.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<br/>
<p align="center"><a href="https://argent.swmansion.com"><img width="1100" height="382" alt="argent-header" src="https://github.com/user-attachments/assets/6cec01d5-da3c-4b6c-97c3-0374a63c213c" /></a></p>
[![Ad](https://swm-delivery.com/www/images/zone-gh-argent-1?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-argent-1&n=1)
[![Ad](https://swm-delivery.com/www/images/zone-gh-argent-2?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-argent-2&n=1)
[![Ad](https://swm-delivery.com/www/images/zone-gh-argent-3?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-argent-3&n=1)
**[Argent](https://argent.swmansion.com)** gives your AI assistant direct control of iOS simulators, Android emulators and devices, TVs (Apple TV, Android TV, Fire TV) and Electron/Chromium apps. Tap a button, profile a screen, reproduce a bug - without leaving the CLI.
```bash
npx @swmansion/argent@latest init # pnpm: pnpm dlx @swmansion/argent@latest init
```
<p align="center"><img src="https://github.com/software-mansion/argent/blob/main/assets/showcase.gif" alt="argent showcase video gif" width="100%" /></p>
## What it does
- **Interact** - tap, swipe, gesture, type, hardware buttons; D-pad on TV; mouse and keyboard on desktop.
- **Flows** - record a path once, replay it deterministically as a repro or smoke test.
- **Visual regression** - diff a baseline against a live capture, OCR- and font-aware.
- **Profiling** - Hermes, React DevTools, Xcode Instruments, Perfetto: renders, CPU hotspots, hangs.
- **Debugging** - logs, network (`fetch` and native), JS evaluation, native and React trees.
- **React Native** - build, launch and iterate, no extra setup.
Ask your assistant _"What can Argent do?"_ to list every tool.
## Documentation
[Installation](https://docs.swmansion.com/argent/docs/fundamentals/installation) · [Platforms](https://docs.swmansion.com/argent/docs/fundamentals/supported-platforms) · [CLI](https://docs.swmansion.com/argent/docs/reference/cli) · [Editors](https://docs.swmansion.com/argent/docs/reference/editors)
## Privacy
Telemetry is opt-out: `argent telemetry disable`. See the [Privacy Notice](https://github.com/software-mansion/argent/blob/main/Telemetry.md).
## License
Argent uses a mixed licensing model. **Source code** is released under the [Apache License 2.0](LICENSE.txt). **Proprietary binaries** (the per-platform `bin/<platform>/simulator-server` and `bin/darwin/ax-service` executables and the `.dylib` files in `native-devtools-ios`) are the intellectual property of Software Mansion S.A. and are licensed solely for use within this project. Decompiling, reverse-engineering, or redistributing them without explicit written permission is prohibited. By using Argent, you acknowledge and agree to this structure. See [LICENSE](https://github.com/software-mansion/argent/blob/main/LICENSE.txt) for full details.
## Argent is created by Software Mansion
Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=argent&utm_medium=readme).
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=argent-github "Software Mansion")](https://swmansion.com)