From 6ad8f3aeb43e64b6fb6954797aa3bd4b713ac3c3 Mon Sep 17 00:00:00 2001 From: Lars-Magnus Skog Date: Wed, 29 May 2019 00:34:35 +0200 Subject: [PATCH 1/3] docs: add quick intro to repl tool --- README.md | 114 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 114 insertions(+) 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 +============================================= +``` From 377014928e7b7bbc36a2285c537a3ca47e9329a4 Mon Sep 17 00:00:00 2001 From: Lars-Magnus Skog Date: Wed, 29 May 2019 00:37:30 +0200 Subject: [PATCH 2/3] Remove list of commands --- README.md | 65 +------------------------------------------------------ 1 file changed, 1 insertion(+), 64 deletions(-) diff --git a/README.md b/README.md index e3148ca40..94d52318d 100644 --- a/README.md +++ b/README.md @@ -69,71 +69,8 @@ Single#10: yourfriends@email.org [yourfriends@email.org] Message sent. ``` -For more commands type `> help`: +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 -============================================= ``` From 1c0431e2f2fc7be4d3cd5a42d02cc9177ed9bf29 Mon Sep 17 00:00:00 2001 From: Lars-Magnus Skog Date: Wed, 29 May 2019 00:38:32 +0200 Subject: [PATCH 3/3] Remove incorrect comment on building header file --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 94d52318d..fa21151fe 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,8 @@ Current commit on deltachat/deltachat-core: `12ef73c8e76185f9b78e844ea673025f56a ```sh # run example $ cargo run --example simple -# build header file +# build c-ffi $ cargo build -p deltachat_ffi --release -$ cat deltachat-ffi/deltachat.h # run tests $ cargo test --all ```