https://github.com/zach-klippenstein/adbfs
A FUSE filesystem that uses goadb to expose Android devices' filesystems.
https://github.com/zach-klippenstein/adbfs
Last synced: 3 months ago
JSON representation
A FUSE filesystem that uses goadb to expose Android devices' filesystems.
- Host: GitHub
- URL: https://github.com/zach-klippenstein/adbfs
- Owner: zach-klippenstein
- License: apache-2.0
- Created: 2015-05-03T12:39:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T13:57:27.000Z (9 months ago)
- Last Synced: 2025-02-02T14:56:02.061Z (3 months ago)
- Language: Go
- Homepage:
- Size: 975 KB
- Stars: 153
- Watchers: 8
- Forks: 13
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# adbfs [](https://travis-ci.org/zach-klippenstein/adbfs) [](https://godoc.org/github.com/zach-klippenstein/adbfs)
A FUSE filesystem that uses [goadb](https://github.com/zach-klippenstein/goadb) to expose Android devices' filesystems.
## Features
* Read access to Android device filesystems through adb, *without root*. Of course, this is limited to files that are accessible to whatever user `adb shell` runs the shell as on the device.
* Experimental write support (run with `--no-readonly`). Notably, on OSX, Finder can't copy files into mounted directories ([issue #34](https://github.com/zach-klippenstein/adbfs/issues/34)).
* Automounter daemon that detects when devices are connected and mounts them under a configurable directory.
* Communicates directly with adb server using goadb instead of delegating to the adb client command like most adb-based filesystems.
## Quick Start
### Installation
adbfs depends on fuse. For OS X, install osxfuse.
Then run:
```
$ export GO15VENDOREXPERIMENT=1
$ go get github.com/zach-klippenstein/adbfs
$ cd `go list -f '{{.Dir}}' github.com/zach-klippenstein/adbfs`
$ ./install.sh
```
### Let's mount some devices!
The easiest way to start mounting devices is to use `adbfs-automount` to watch for newly-connected devices
and automatically mount them.
```
$ mkdir ~/mnt
$ adbfs-automount
```
You probably want to run this as a service when you login (e.g. create a LaunchAgent on OSX).
For example, on OSX, paste this into `~/Library/LaunchAgents/com.adbfs-automount.plist` (substituting "zach" for your own username, of course):
```xml
Label
com.adbfs-automount
ProgramArguments
/Users/zach/go/bin/adbfs-automount
--adb=/Users/zach/android-sdk/platform-tools/adb
--adbfs=/Users/zach/go/bin/adbfs
RunAtLoad
KeepAlive
StandardOutPath
/Users/zach/adbfs.log
StandardErrorPath
/Users/zach/adbfs.log
```
then run
```
$ launchctl load ~/Library/LaunchAgents/com.adbfs-automount.plist
$ launchctl start com.adbfs-automounter
```
## adfs
### Usage
Devices are specified by serial number. To list the serial numbers of all connected devices, run:
`adb devices -l`
The serial number is the left-most column. To mount a device with serial number `02b5c5a809117c73` on `/mnt`, run:
`adbfs --device 02b5c5a809117c73 --mountpoint /mnt`
Example:
```
$ adb devices -l
List of devices attached
02b5c5a809117c73 device usb:14100000 product:hammerhead model:Nexus_5 device:hammerhead
$ mkdir ~/mnt
$ adbfs -device 02b5c5a809117c73 -mountpoint ~/mnt
INFO[2015-09-07T16:13:03.386813059-07:00] stat cache ttl: 300ms
INFO[2015-09-07T16:13:03.387113547-07:00] connection pool size: 2
INFO[2015-09-07T16:13:03.400838775-07:00] server ready.
INFO[2015-09-07T16:13:03.400884026-07:00] mounted 02b5c5a809117c73 on /Users/zach/mnt
⋮
```
## adbfs-automount
`adbfs-automount` listens for new device connections to adb and runs an instance of `adbfs` for each device to mount
it. Most arguments are passed through to `adbfs`, but there are a few arguments specific to the automounter:
`--root`: the directory under which to mount devices. If this is not specified, it will try to figure out
a good path. On OSX, `~/mnt` is used if it exists, else `/Volumes`. On Linux, it tries `~/mnt` then `/mnt`.
`--adbfs`: path to the adbfs executable to run. If not specified, will search `$PATH`. The executable _must_ be built
from the same SHA as `adbfs-automount`, which will exit with an error if this is not the case.
`--on-(un)mount`: a command to run when a device is (un)mounted. Can be repeated to run multiple commands.
E.g. `--on-mount 'say $ADBFS_MODEL' --on-mount 'open $ADBFS_PATH'` will speak the type of device and open it in Finder.
## Running from Source
```
$ go run cmd/adbfs/main.go …
```