Skip to content

Latest commit

 

History

History
145 lines (110 loc) · 4.72 KB

readme.md

File metadata and controls

145 lines (110 loc) · 4.72 KB
Raw

Geek Mobile Toolkit

=========

Everything a geek needs to create, build, and manage cross-platform native mobile apps.

oclif Version Downloads/week License

Usage

$ npm install -g @geek/mobile
$ mobile COMMAND
running command...
$ mobile (-v|--version|version)
@geek/mobile/1.0.5 darwin-x64 node-v12.16.3
$ mobile --help [COMMAND]
USAGE
  $ mobile COMMAND
...

Commands

mobile app:create [NAME] [TEMPLATE]

Create a shiny new mobile application

USAGE
  $ mobile app:create [NAME] [TEMPLATE]

ARGUMENTS
  NAME      Name of your project
  TEMPLATE  Template to use for creating your new app

OPTIONS
  -c, --copyright=copyright          Copyright for your project
  -d, --description=description      Description for your project
  -g, --guid=guid                    GUID for your project
  -i, --id=id                        ID for your project
  -l, --license=license              [default: MIT] Specifies the license for the project
  -n, --name=name                    Name of your project
  -p, --path=path                    Specifies the directory where you want to initialize the project
  -p, --publisher=publisher          Name of person/company publishing app
  -t, --template=template            Template to use for creating your new app
  -u, --url=url                      URL for your project
  --author_email=author_email        Specifies the email address of the Author
  --author_name=author_name          Specifies the full name of the Author
  --author_url=author_url            Specifies the URL for the Author
  --bugs_email=bugs_email            Email address for submitting issues/bugs
  --bugs_url=bugs_url                Specifies the URL for submitting issues/bugs
  --github_username=github_username  Specifies the github username for the project
  --repo_url=repo_url                Specifies the URL for the repo

DESCRIPTION
  ...
  Create a new mobile app from a template using all sorts of nifty options!

  Tool will create an app using values from parameters or from the user config file which is located here:  
  ~/.config/@geek/mobile/config.json
  Future versions of the tool will allow setting config values from CLI.

EXAMPLES

  undefined

  undefined my-app-name [@scope/]<name>
  undefined my-app-name [@scope/]<name>@<tag>
  undefined my-app-name [@scope/]<name>@<version>
  undefined my-app-name [@scope/]<name>@<version range>

  undefined

  undefined my-app-name <git-host>:<git-user>/<repo-name>
  undefined my-app-name <git-host>:<git-user>/<repo-name>#<tag>
  undefined my-app-name <git-host>:<git-user>/<repo-name>#<branch>
  undefined my-app-name <git repo url>

  undefined

  undefined

  undefined my-app-name <tarball file>
  undefined my-app-name <tarball url>

  undefined

  undefined my-app-name <folder>

See code: src/commands/app/create.js

mobile help [COMMAND]

display help for mobile

USAGE
  $ mobile help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mobile which COMMAND

show which plugin a command is in

USAGE
  $ mobile which COMMAND

See code: @oclif/plugin-which

Roadmap

  • app:create - Create a new mobile app project from templates
  • app:build - Build iOS/Android mobile apps
  • app:run - Run mobile app on simulator or device
  • app:clean - Clean up build artifacts from project
  • resource:icons - Manage iOS/Android icons for app
  • resource:images - Manage images for mobile project
  • resource:splashes - Manage images for mobile project
  • config:user - Get/Set properties in user config file
  • config:project - Get/Set properties in project config file
  • alias:create - Create an alias for executing multiple commands with optional parameters
  • Optional prompting for parameters
  • User configuration file
  • Project configuration file