Skip to content

Latest commit

 

History

History
177 lines (98 loc) · 4.31 KB

README.rst

File metadata and controls

177 lines (98 loc) · 4.31 KB
Raw

Sweech command line interface

What's this ?

It's a command line tool to interact with Sweech Wifi file transfer.

Sweech is an Android app with which you can browse the content of your phone and transfer files. It's based on an HTTP server. This tool interacts with Sweech's HTTP API. You can push and pull files over wifi directly from your favorite shell

OK, show me !

https://asciinema.org/a/113791.png

Nice, how do I get it ?

Use python's pip

$ pip install sweech-cli

Or download the python script and add it to your $PATH

$ curl -o sweech https://raw.githubusercontent.com/alberthier/sweech-cli/master/sweech.py

Or

$ wget -O sweech https://raw.githubusercontent.com/alberthier/sweech-cli/master/sweech.py

How do I use it ?

The sweech tool is totally standalone:

$ sweech -u http://192.168.0.65 info

It may be practical to create a config file containing the connection settings: ~/.config/sweech.json on Linux/macOS, %APPDATA%/sweech.json on Windows

Here is an example file for a phone having 192.168.0.65 as IP address

{
    "url": "http://192.168.0.65:4444",
    "user": "",
    "password": "",
    "defaultdir": "/storage/emulated/0/Downloads"
}

If you define a defaultdir, all relative remote paths will be interpreted relatively to this default directory.

Assuming you have added sweech to your PATH:

$ sweech info

Prints information and default paths of your device

$ sweech ls /storage/emulated/0/Download

List the content of a folder or display details of a file

$ sweech push testdir

Pushes files or directories to a remote path. If no remote file is specified, defaultdir is used

You can only create files and directories in the internal storage. External storage (SD card) is writable too if you have granted Sweech this authorisation in the app's settings.

The --keep option uploads only missing files on the remote device. Existing files are left untouched.

$ sweech pull testdir

Pull files and folders from the remote device to a local folder. If remote file path is relative, defaultdir is used as base

The --keep option downloads only missing local files. Existing files are left untouched.

$ sweech mkdir testdir

Creates a directory. Missing intermediate directories are created too

$ sweech rm /some/path

Removes a file or a directory (with its content)

$ sweech mv /some/path /some/otherpath

Moves a file or a directory (with its content). Moving files between directories may be slow in some circumstances (between different storages, on external SD card on Android pre 7.0)

$ sweech cat /path/to/some/file.txt

Displays the content of a file

$ sweech clipboard

Displays the content of the Android clipboard

$ sweech clipboard "Hello World"

Sets the content of the Android clipboard

And what if I want to use it in my Python script ?

Simply import the sweech module and use the Connector object. All CLI commands have their equivalent method:

import sweech

c = sweech.Connector('http://192.168.0.11:4444')

print(c.info())

for f in c.ls('/storage/emulated/0/Download'):
    print(f)

with open('test.txt', 'wt') as f:
    f.write('Hello World')

c.push('test.txt', '/storage/emulated/0/Download')

c.pull('/storage/emulated/0/Download/test.txt', '/tmp')

f = c.cat('/storage/emulated/0/Download/test.txt')
print(f.read().decode('utf-8'))
f.close()

c.mkdir('/storage/emulated/0/Download/testdir')

c.mv('/storage/emulated/0/Download/testdir', '/storage/emulated/0/Download/testdir2')

c.rm('/storage/emulated/0/Download/testdir2')

txt = c.clipboard()
c.clipboard(txt + " hello world")

Dependencies

  • Python 2.7 or Python 3.5+

Contributing

Report issues here

Pull-requests welcome !