diff --git a/README.md b/README.md index 816f7b898..e3148ca40 100644 --- a/README.md +++ b/README.md @@ -23,3 +23,117 @@ $ cargo test --all [circle]: https://circleci.com/gh/deltachat/deltachat-core-rust/ [appveyor-shield]: https://ci.appveyor.com/api/projects/status/lqpegel3ld4ipxj8/branch/master?style=flat-square [appveyor]: https://ci.appveyor.com/project/dignifiedquire/deltachat-core-rust/branch/master + +## Using the CLI client + +Run using `cargo`: + +``` +cargo run --example repl -- /path/to/db +``` + +Configure your account (if not already configured): + +``` +Delta Chat Core is awaiting your commands. +> set addr your@email.org +> set mail_pw yourpassword +> configure +``` + +If you're already configured it's enough to `> connect`. + +Create a contact: + +``` +> addcontact yourfriends@email.org +Command executed successfully. +``` + +List contacts: + +``` +> listcontacts +Contact#10: +Contact#1: Me √√ +``` + +Create a chat with your friend and send a message: + +``` +> createchat 10 +Single#10 created successfully. +> chat 10 +Single#10: yourfriends@email.org [yourfriends@email.org] +> send hi +Message sent. +``` + +For more commands type `> help`: + +``` +> help +==========================Database commands== +info +open +close +set [] +get +oauth2 +configure +connect +disconnect +maybenetwork +housekeeping +help imex (Import/Export) +==============================Chat commands== +listchats [] +listarchived +chat [|0] +createchat +createchatbymsg +creategroup +createverified +addmember +removemember +groupname +groupimage [] +chatinfo +sendlocations +setlocation +dellocations +getlocations [] +send +sendimage [] +sendfile +draft [] +listmedia +archive +unarchive +delchat +===========================Message commands== +listmsgs +msginfo +listfresh +forward +markseen +star +unstar +delmsg +===========================Contact commands== +listcontacts [] +listverified [] +addcontact [] +contactinfo +delcontact +cleanupcontacts +======================================Misc.== +getqr [] +getbadqr +checkqr +event +fileinfo +clear -- clear screen +exit +============================================= +```