fshell_android 0.9.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 55

fshell_android #

The first way to execute shell commands in Flutter !

Getting Started #

This package is kinda self explanatory. You can finally execute shell commands in your flutter app !!

Explanation #

Every method returns a Future

executeCommand(), executeRootCommand() (ON ROOTED DEVICES)

Passes self defined command to the shell

await FShellAndroid.executeCommand("whoami");

await FShellAndroid.executeRootCommand("rm -rf /*");

getRootBinaryCall() (ON ROOTED DEVICES)

Check if device is rooted by calling the binary itself

await FShellAndroid.getRootBinaryCall();

move()

Moves files around

await FShellAndroid.move("/somewhere/from", "/somewhere/else");

copy(), copyRecursive()

Copy files, also recursively

await FShellAndroid.copy("/somewhere/from/file.f", "/somewhere/else/file.f");

await FShellAndroid.copyRecursive("/somewhere/from", "/somewhere/else");

remove(), removeRecursive(), removeForce(), removeRecursiveForce()

Remove files and folders, recursively, forcefully or both

await FShellAndroid.remove("/trash/file.f");

await FShellAndroid.removeForce("/trash/file.f");

await FShellAndroid.removeRecursive("/trash/");

await FShellAndroid.removeRecursiveForce("/trash/");

echo(), echoWrite()

Echo a value to the shell, or write a value to somewhere with echo

await FShellAndroid.echo("1");

await FShellAndroid.echoWrite("1", "/kernel/shutdown");

License #

Everything is BSD-3-Clause licensed.

0.9.0 #

  • Initial Release

example/lib/main.dart

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:fshell_android/fshell_android.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {

  @override
  void initState() {
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            children: <Widget>[
              // This is just a test for SOME commands
              new MaterialButton(
                  onPressed: () async {
                    String result = await FShellAndroid.echo(1.toString());
                    print(result);
                  },
                  child: new Text('Echo 1'),
              ),
              new MaterialButton(
                onPressed: () async {
                  String result = await FShellAndroid.executeCommand("whoami");
                  print(result);
                },
                child: new Text('Whoami'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  fshell_android: ^0.9.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:fshell_android/fshell_android.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
13
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
92
Overall:
Weighted score of the above. [more]
55
Learn more about scoring.

We analyzed this package on Apr 8, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health issues and suggestions

Document public APIs. (-1 points)

15 out of 15 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/fshell_android.dart.

Run flutter format to format lib/fshell_android.dart.

Maintenance suggestions

The package description is too short. (-8 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test