Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
wess committed Jul 1, 2019
0 parents commit 1cb31a0
Show file tree
Hide file tree
Showing 15 changed files with 2,208 additions and 0 deletions.
1 change: 1 addition & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export PATH="./bin:./node_modules/.bin:$PATH"
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

## OS
.DS_Store
thumbs.db

## Editors
.dist
.vscode

## Node/Typescript
node_modules
156 changes: 156 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
skafos
======



[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/skafos.svg)](https://npmjs.org/package/skafos)
[![Downloads/week](https://img.shields.io/npm/dw/skafos.svg)](https://npmjs.org/package/skafos)
[![License](https://img.shields.io/npm/l/skafos.svg)](https://github.com/skafos/skafos/blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g skafos
$ skafos COMMAND
running command...
$ skafos (-v|--version|version)
skafos/0.0.0 darwin-x64 node-v12.5.0
$ skafos --help [COMMAND]
USAGE
$ skafos COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`skafos Gen [FILE]`](#skafos-gen-file)
* [`skafos compile [TARGET]`](#skafos-compile-target)
* [`skafos create [PROJECT]`](#skafos-create-project)
* [`skafos deploy [PLATFORM]`](#skafos-deploy-platform)
* [`skafos help [COMMAND]`](#skafos-help-command)
* [`skafos repl`](#skafos-repl)
* [`skafos train [DATA]`](#skafos-train-data)

## `skafos Gen [FILE]`

describe the command here

```
USAGE
$ skafos Gen [FILE]
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
```

_See code: [src/commands/Gen.ts](https://github.com/skafos/skafos/blob/v0.0.0/src/commands/Gen.ts)_

## `skafos compile [TARGET]`

Build current project for specific target

```
USAGE
$ skafos compile [TARGET]
OPTIONS
-h, --help show CLI help
EXAMPLE
$ skafos compile --target=ios
```

_See code: [src/commands/compile.ts](https://github.com/skafos/skafos/blob/v0.0.0/src/commands/compile.ts)_

## `skafos create [PROJECT]`

Create a new Skafos project

```
USAGE
$ skafos create [PROJECT]
OPTIONS
-h, --help show CLI help
EXAMPLE
$ skafos create myproject
```

_See code: [src/commands/create.ts](https://github.com/skafos/skafos/blob/v0.0.0/src/commands/create.ts)_

## `skafos deploy [PLATFORM]`

Deploy project models to provider

```
USAGE
$ skafos deploy [PLATFORM]
OPTIONS
-h, --help show CLI help
EXAMPLE
$ skafos deploy --platform=azure
```

_See code: [src/commands/deploy.ts](https://github.com/skafos/skafos/blob/v0.0.0/src/commands/deploy.ts)_

## `skafos help [COMMAND]`

display help for skafos

```
USAGE
$ skafos help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.0/src/commands/help.ts)_

## `skafos repl`

Interactive shell for current project

```
USAGE
$ skafos repl
OPTIONS
-h, --help show CLI help
EXAMPLE
$ skafos repl
```

_See code: [src/commands/repl.ts](https://github.com/skafos/skafos/blob/v0.0.0/src/commands/repl.ts)_

## `skafos train [DATA]`

Run model and train it with provided data source

```
USAGE
$ skafos train [DATA]
OPTIONS
-h, --help show CLI help
EXAMPLE
$ skafos train --data=/path/to/example
```

_See code: [src/commands/train.ts](https://github.com/skafos/skafos/blob/v0.0.0/src/commands/train.ts)_
<!-- commandsstop -->
5 changes: 5 additions & 0 deletions bin/ska
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env node

require('@oclif/command').run()
.then(require('@oclif/command/flush'))
.catch(require('@oclif/errors/handle'))
3 changes: 3 additions & 0 deletions bin/ska.cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@echo off

node "%~dp0\run" %*
52 changes: 52 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"name": "skafos",
"version": "0.0.0",
"author": "Wess Cope @wess",
"bin": {
"skafos": "./bin/ska"
},
"bugs": "https://github.com/skafos/skafos/issues",
"dependencies": {
"@oclif/command": "^1",
"@oclif/config": "^1",
"@oclif/plugin-help": "^2",
"tslib": "^1"
},
"devDependencies": {
"@oclif/dev-cli": "^1",
"@types/node": "^10",
"globby": "^8",
"ts-node": "^8",
"typescript": "^3.3"
},
"engines": {
"node": ">=8.0.0"
},
"files": [
"/bin",
"/lib",
"/npm-shrinkwrap.json",
"/oclif.manifest.json"
],
"homepage": "https://github.com/skafos/skafos",
"keywords": [
"oclif"
],
"license": "MIT",
"main": "lib/index.js",
"oclif": {
"commands": "./lib/commands",
"bin": "skafos",
"plugins": [
"@oclif/plugin-help"
]
},
"repository": "skafos/skafos",
"scripts": {
"postpack": "rm -f oclif.manifest.json",
"prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
"test": "echo NO TESTS",
"version": "oclif-dev readme && git add README.md"
},
"types": "lib/index.d.ts"
}
29 changes: 29 additions & 0 deletions src/commands/compile.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* compile.ts
* skafos
*
* Created by Wess Cope ([email protected]) on 07/01/19
* Copyright 2019 Skafos,llc.
*/

import {Command, flags} from '@oclif/command';

export default class Compile extends Command {
static description = "Build current project for specific target";

static examples = [
`$ skafos compile --target=ios`
]

static flags = {
help: flags.help({char: 'h'})
}

static args = [{
name: 'target'
}]

async run() {

}
}
29 changes: 29 additions & 0 deletions src/commands/create.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* create.ts
* skafos
*
* Created by Wess Cope ([email protected]) on 07/01/19
* Copyright 2019 Skafos,llc.
*/

import {Command, flags} from '@oclif/command';

export default class Create extends Command {
static description = "Create a new Skafos project";

static examples = [
`$ skafos create myproject`
]

static flags = {
help: flags.help({char: 'h'})
}

static args = [{
name: 'project'
}]

async run() {

}
}
29 changes: 29 additions & 0 deletions src/commands/deploy.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* deploy.ts
* skafos
*
* Created by Wess Cope ([email protected]) on 07/01/19
* Copyright 2019 Skafos,llc.
*/

import {Command, flags} from '@oclif/command';

export default class Deploy extends Command {
static description = "Deploy project models to provider";

static examples = [
`$ skafos deploy --platform=azure`
]

static flags = {
help: flags.help({char: 'h'})
}

static args = [{
name: 'platform'
}]

async run() {

}
}
28 changes: 28 additions & 0 deletions src/commands/gen.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* gen.ts
* skafos
*
* Created by Wess Cope ([email protected]) on 07/01/19
* Copyright 2019 Skafos,llc.
*/

import {Command, flags} from '@oclif/command'

export default class Gen extends Command {
static description = 'Interface to working with generators';

static flags = {
help: flags.help({char: 'h'}),
list: flags.boolean({
char: 'l',
description: 'List of a available generators.'
}),
search: flags.string({
char: 's',
description: 'Search generators.'
})
}

async run() {
}
}
25 changes: 25 additions & 0 deletions src/commands/repl.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* repl.ts
* skafos
*
* Created by Wess Cope ([email protected]) on 07/01/19
* Copyright 2019 Skafos,llc.
*/

import {Command, flags} from '@oclif/command';

export default class Repl extends Command {
static description = "Interactive shell for current project";

static examples = [
`$ skafos repl`
]

static flags = {
help: flags.help({char: 'h'})
}

async run() {

}
}
Loading

0 comments on commit 1cb31a0

Please sign in to comment.