Skip to content

Commit 38fa1cd

Browse files
Add open source branding and disclaimer
1 parent 17161c0 commit 38fa1cd

4 files changed

Lines changed: 48 additions & 7 deletions

File tree

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
1-
# wise-cli
1+
<p align="center">
2+
<img src="docs/assets/logo.svg" alt="wise-cli logo" width="128" height="128">
3+
</p>
24

3-
[![npm](https://img.shields.io/npm/v/%40brahimhamichan%2Fwise-cli)](https://www.npmjs.com/package/@brahimhamichan/wise-cli)
5+
<h1 align="center">wise-cli</h1>
6+
7+
<p align="center">
8+
An unofficial, open source CLI for the Wise Platform API.
9+
</p>
10+
11+
[![npm package](https://img.shields.io/badge/npm-configured%2C%20not%20published-lightgrey)](https://www.npmjs.com/package/@brahimhamichan/wise-cli)
412
[![CI](https://github.com/brahimhamichan/wise-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/brahimhamichan/wise-cli/actions/workflows/ci.yml)
513
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
614
[![Node.js >=20](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](package.json)
715
[![skills.sh](https://skills.sh/b/brahimhamichan/wise-cli)](https://skills.sh/brahimhamichan/wise-cli)
816

917
Use the Wise Platform API from your terminal.
1018

11-
`wise-cli` is an unofficial TypeScript CLI for the current Wise Platform API. It wraps profile, balance, recipient, quote, transfer, statement, and currency endpoints behind one command surface while leaving a raw `wise api` escape hatch for newly released endpoints.
19+
`wise-cli` is an independent TypeScript CLI for the current Wise Platform API. It wraps profile, balance, recipient, quote, transfer, statement, and currency endpoints behind one command surface while leaving a raw `wise api` escape hatch for newly released endpoints.
1220

1321
![wise-cli terminal demo](docs/assets/terminal-demo.svg)
1422

@@ -17,7 +25,15 @@ This first public release is intentionally conservative:
1725
- It is built around the currently documented Wise production and sandbox APIs.
1826
- It supports personal-token auth out of the box.
1927
- It keeps dynamic payloads as JSON bodies so the CLI stays compatible with Wise's mixed endpoint versions and changing requirements.
20-
- It is not affiliated with, endorsed by, or maintained by Wise.
28+
- It is independent and not affiliated with Wise.
29+
30+
## Legal disclaimer
31+
32+
`wise-cli` is an open source community project. It is not affiliated with, sponsored by, endorsed by, or maintained by Wise Payments Limited, Wise plc, Wise.com, or any Wise group company.
33+
34+
Wise, Wise Platform, Wise.com, and TransferWise are trademarks or registered trademarks of Wise Payments Limited or its affiliates. Any use of those names in this project is solely for identification, interoperability, and documentation of the public Wise Platform API.
35+
36+
This project does not provide financial, legal, tax, or compliance advice. You are responsible for complying with Wise's terms, API requirements, token permissions, regional restrictions, and all applicable laws when using this CLI.
2137

2238
## Why use it?
2339

@@ -27,7 +43,15 @@ This first public release is intentionally conservative:
2743

2844
## Install
2945

30-
The GitHub repo is public as `brahimhamichan/wise-cli`. The npm package is scoped because the unscoped `wise-cli` name is already taken on npm.
46+
The GitHub repo is public as `brahimhamichan/wise-cli`. The npm package is configured as `@brahimhamichan/wise-cli` because the unscoped `wise-cli` name is already taken on npm.
47+
48+
Until the package is published to npm, install from the GitHub repo:
49+
50+
```bash
51+
npm install -g github:brahimhamichan/wise-cli
52+
```
53+
54+
After the npm package is published:
3155

3256
```bash
3357
npm install -g @brahimhamichan/wise-cli
@@ -192,6 +216,7 @@ The current implementation and references were aligned against Wise's public doc
192216

193217
- [Getting started](https://docs.wise.com/guides/developer)
194218
- [Security and access](https://docs.wise.com/guides/developer/auth-and-security)
219+
- [Wise API terms and conditions](https://wise.com/public-resources/assets/documents/api/api_terms_and_conditions.pdf)
195220
- [API reference overview](https://docs.wise.com/api-reference)
196221
- [Versioning](https://docs.wise.com/api-docs/api-reference/versioning)
197222
- [Profile](https://docs.wise.com/api-reference/profile/profile)

docs/assets/logo.svg

Lines changed: 10 additions & 0 deletions
Loading

docs/launch-post.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@ Why I built it:
2020
- Some workflows are easier to automate from a terminal or CI job than from custom app code.
2121
- A raw `wise api` command keeps the CLI useful when Wise adds endpoints before dedicated commands exist.
2222

23-
Install:
23+
Install from GitHub:
24+
25+
```bash
26+
npm install -g github:brahimhamichan/wise-cli
27+
```
28+
29+
The npm package is configured as `@brahimhamichan/wise-cli` and can be published when ready:
2430

2531
```bash
2632
npm install -g @brahimhamichan/wise-cli

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@brahimhamichan/wise-cli",
33
"version": "0.1.0",
4-
"description": "Public Wise Platform CLI for profiles, balances, recipients, quotes, transfers, statements, and raw API calls.",
4+
"description": "Unofficial open source CLI for Wise Platform API profiles, balances, recipients, quotes, transfers, statements, and raw API calls.",
55
"license": "MIT",
66
"type": "module",
77
"repository": {

0 commit comments

Comments
 (0)