cli

README

YoMo CLI

Command-line tools for YoMo

Binary

curl -fsSL https://get.yomo.run | sh

Build from source

Installing Go

You can easily install the latest release globally by running:

go install github.com/yomorun/yomo/cmd/yomo@latest

Or you can install into another directory:

env GOBIN=/bin go install github.com/yomorun/yomo/cmd/yomo@latest

Getting Started

1. Source

Write a source app

See example/source/main.go

Run

go run main.go

2. Stream Function

Init

Create a stream function

yomo init [Name]

Run

cd [Name] && yomo run

OR in Production

cd [Name] && yomo build && ./sl.yomo

3. Stream Function to store data in DB

Write a stream function

See example/stream-fn-db/app.go

Run

cd example/stream-fn-db && yomo run

OR in Production

cd example/stream-fn-db && yomo build && ./sl.yomo

4. YoMo-Zipper

Configure YoMo-Zipper config.yaml

name: Service
host: localhost
port: 9000
functions:
  - name: Noise
  - name: MockDB

Run

yomo serve --config config.yaml

Example

Prerequisites

Installing task

Simple Example

Run

task example

Edge-Mesh

Run US Node

task example-mesh-us

Run EU Node

task example-mesh-eu

Documentation

Overview

Copyright © 2021 Allegro Networks

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Allegro Networks

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Allegro Networks

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Allegro Networks

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Allegro Networks

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Allegro Networks

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Allegro Networks

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func Execute()
• func GetRootPath() string
• func GetVersion() string

Variables

var (
	Version = ""
	Date    = ""
)

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func GetRootPath

func GetRootPath() string

GetRootPath get root path

func GetVersion

func GetVersion() string

GetVersion get CLI version