Skip to content

Commit 15e1872

Browse files
author
larp-agent
committed
Initial commit: svmai CLI tool with vanity wallet generation feature
1 parent d568bc8 commit 15e1872

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# svmai - Solana Wallet Management CLI
22

3+
[![GitHub](https://img.shields.io/github/license/openSVM/svmai-cli)](https://github.com/openSVM/svmai-cli/blob/master/LICENSE)
4+
[![GitHub stars](https://img.shields.io/github/stars/openSVM/svmai-cli)](https://github.com/openSVM/svmai-cli/stargazers)
5+
[![GitHub issues](https://img.shields.io/github/issues/openSVM/svmai-cli)](https://github.com/openSVM/svmai-cli/issues)
6+
37
`svmai` is a command-line interface (CLI) tool built with Rust for managing Solana wallets. It allows users to find Solana wallet files, securely store their private keys using system keychain encryption, manage multiple wallets, view balances, and perform batch operations and token mixing for enhanced privacy.
48

59
## Features
@@ -34,8 +38,11 @@
3438

3539
### Building from Source
3640

37-
1. Clone the repository (or download the source code).
38-
2. Navigate to the project directory: `cd svmai`
41+
1. Clone the repository (or download the source code):
42+
```bash
43+
git clone https://github.com/openSVM/svmai-cli.git
44+
```
45+
2. Navigate to the project directory: `cd svmai-cli`
3946
3. Build the project: `cargo build --release`
4047
4. The executable will be located at `target/release/svmai`.
4148

@@ -265,6 +272,16 @@ The application uses a combination of:
265272
* For longer prefixes (more than 3 characters), expect significantly longer search times
266273
* Consider increasing the timeout for more complex prefixes
267274

275+
## Contributing
276+
277+
Contributions are welcome! Please feel free to submit a Pull Request.
278+
279+
1. Fork the repository
280+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
281+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
282+
4. Push to the branch (`git push origin feature/amazing-feature`)
283+
5. Open a Pull Request
284+
268285
## Disclaimer
269286

270287
This tool interacts with Solana private keys and can perform transactions on the Solana network that involve real cryptocurrency. **Use it at your own risk.** The authors are not responsible for any loss of funds. Always ensure you understand what the tool is doing, especially when authorizing transactions or managing private keys. For the token mixing feature, the current implementation is a **simulation** and does not execute real mixing transactions on the network to avoid accidental fund transfers during this demonstration phase.

0 commit comments

Comments
 (0)