@514labs/moose-cli 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +87 -0
- package/package.json +33 -0
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Moose CLI
|
|
2
|
+
|
|
3
|
+
The Moose CLI is your entrypoint to a seamless, local development experience for you data-intensive application. It's written in rust and supports building applications in TypeScript and Python.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Before getting started you'll need to install some dependencies on your machine:
|
|
8
|
+
|
|
9
|
+
1. Node
|
|
10
|
+
2. Docker
|
|
11
|
+
|
|
12
|
+
The Moose CLI is available as an NPM. To install the CLI, run the following command:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install -g moose
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
The Moose CLI is a command-line tool that allows you to create, manage, and deploy your Moose applications.
|
|
21
|
+
|
|
22
|
+
### Creating a new application
|
|
23
|
+
|
|
24
|
+
To create a new application, run the following command:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
igloo init
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
This will prompt you to enter a name for your application. Once you have entered a name, the CLI will create a new directory with the name you provided and scaffold out a new Moose application.
|
|
31
|
+
|
|
32
|
+
#### Application structure
|
|
33
|
+
|
|
34
|
+
The CLI will create the following files and directories:
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
├── .igloo
|
|
38
|
+
│ ├── .clickhouse
|
|
39
|
+
│ ├── .redpanda
|
|
40
|
+
│ └── ...
|
|
41
|
+
├── .gitignore
|
|
42
|
+
├── README.md
|
|
43
|
+
├── package.json or requirements.txt
|
|
44
|
+
├── app
|
|
45
|
+
│ ├── index.ts or index.py
|
|
46
|
+
│ ├── dataframes
|
|
47
|
+
│ │ └── ...
|
|
48
|
+
│ ├── flows
|
|
49
|
+
│ │ └── ...
|
|
50
|
+
│ ├── ingests
|
|
51
|
+
│ │ └── ...
|
|
52
|
+
│ ├── insights
|
|
53
|
+
│ │ ├── dashboards
|
|
54
|
+
│ │ ├── metrics
|
|
55
|
+
│ │ ├── models
|
|
56
|
+
│ │ └── ...
|
|
57
|
+
│ └── utils
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
##### `app` directory
|
|
61
|
+
|
|
62
|
+
The `app` directory contains all of the code for your application. This includes all of the dataframes, flows, ingests, and insights that make up your application. This directory is where you will spend most of your time developing your application.
|
|
63
|
+
|
|
64
|
+
##### `.igloo` for contributors only
|
|
65
|
+
|
|
66
|
+
The `.igloo` directory contains all of the configuration files for an application. This includes configuration for the local state of the application as well as any required local infrastructure. This directory is only used by contributors to the application and should not be committed to source control. Modifying files in this directory may cause unexpected behavior.
|
|
67
|
+
|
|
68
|
+
### Running your application in development mode
|
|
69
|
+
|
|
70
|
+
To run your application, run the following command:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
igloo dev
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
This will start all of the required infrastructure and run your application in development mode. You can now make changes to your application and see them reflected in real-time.
|
|
77
|
+
|
|
78
|
+
### Seeing your application in action
|
|
79
|
+
|
|
80
|
+
Once your application is running, you can see it in action by navigating to the following URLs:
|
|
81
|
+
|
|
82
|
+
- [http://localhost:4000](http://localhost:4000) - Your application's interface if you've created one
|
|
83
|
+
- [http://localhost:4000/console](http://localhost:4000/console) - A console to see the data flowing through your application and the objects you've created
|
|
84
|
+
|
|
85
|
+
#### The console
|
|
86
|
+
|
|
87
|
+
The console is a great way to see the data flowing through your application. It allows you to see the data flowing through your application in real-time and interact with the objects you've created. You can also use the console to run queries against your application's data.
|
package/package.json
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@514labs/moose-cli",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"bin": {
|
|
5
|
+
"igloo": "dist/index.js",
|
|
6
|
+
"igloo-cli": "dist/index.js"
|
|
7
|
+
},
|
|
8
|
+
"files": [
|
|
9
|
+
"dist"
|
|
10
|
+
],
|
|
11
|
+
"scripts": {
|
|
12
|
+
"typecheck": "tsc --noEmit",
|
|
13
|
+
"lint": "eslint .",
|
|
14
|
+
"lint:fix": "eslint . --fix",
|
|
15
|
+
"build": "tsc"
|
|
16
|
+
},
|
|
17
|
+
"devDependencies": {
|
|
18
|
+
"@types/node": "18.16.19",
|
|
19
|
+
"@typescript-eslint/eslint-plugin": "^5.62.0",
|
|
20
|
+
"@typescript-eslint/parser": "^5.62.0",
|
|
21
|
+
"eslint": "^8.46.0",
|
|
22
|
+
"tsconfig": "workspace:0.0.0",
|
|
23
|
+
"typescript": "^4.9.5"
|
|
24
|
+
},
|
|
25
|
+
"optionalDependencies": {
|
|
26
|
+
"@514labs/moose-cli-darwin-arm64": "latest",
|
|
27
|
+
"@514labs/moose-cli-darwin-x64": "latest",
|
|
28
|
+
"@514labs/moose-cli-linux-arm64": "latest",
|
|
29
|
+
"@514labs/moose-cli-linux-x64": "latest",
|
|
30
|
+
"@514labs/moose-cli-windows-arm64": "latest",
|
|
31
|
+
"@514labs/moose-cli-windows-x64": "latest"
|
|
32
|
+
}
|
|
33
|
+
}
|