Skip to content

Commit

Permalink
Updated documentation with TagoIO deploy URL to config file
Browse files Browse the repository at this point in the history
  • Loading branch information
@mateuscardosodeveloper
mateuscardosodeveloper committed Aug 5, 2024
1 parent 6fc59e4 commit 2ea394d
Showing 1 changed file with 46 additions and 38 deletions.
84 changes: 46 additions & 38 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
</p>

# Table of Contents

- [TagoIO Command Line Tools](#tagoio-command-line-tools)
- [How to Install](#how-to-install)
- [Command List](#command-list)
Expand All @@ -16,6 +17,7 @@
For more information on the latest release notes, please visit the [Release Notes section](https://github.com/tago-io/tagoio-cli/releases)

## TagoIO Command Line Tools

TagoIO Command Line Tools is a CLI tool that allows you to interact with TagoIO platform and manage your applications. You can use it to deploy, run, trigger, and debug your analysis, as well as to inspect, backup, and configure your devices. You can also export your applications from one profile to another.

To use this tool, you need to install it globally with npm and also install the builder dependency. You also need to generate a tagoconfig.json file for your project and a .tago-lock file for your profile. You can work with multiple environments by using the init and set-env commands.
Expand All @@ -24,24 +26,23 @@ For more information about the commands and options of this tool, please refer t

![CLI Demo](./docs/images/tagoio_inspect.png)


# How to Install

Installing the TagoIO Command Line Tools is a straightforward process. Follow these steps to get started:

1. **Preparation**: Ensure that Node.js and npm are installed on your machine. If not, refer to the [installation guide](^1^).

2. **CLI Tool Installation**: Open your terminal and run the following command to install the CLI tool globally:
```sh
npm install -g @tago-io/cli
```

3. **Builder Dependency Installation**: Next, install the builder dependency using the command:

```sh
npm install -g @tago-io/builder
```

4. **Project Initialization**: Initialize your project by generating a `tagoconfig.json` file. Use the command below and follow the on-screen instructions to provide your credentials or profile-token (available in your TagoIO account):

```sh
tagoio init
```
Expand All @@ -52,48 +53,51 @@ Installing the TagoIO Command Line Tools is a straightforward process. Follow th
```

## Command List

List of commands of the CLI
**Usage**:

- tagoio [options] [command]

**Options**:
- -V, --version output the version number
- -h, --help display help for command

- -V, --version output the version number
- -h, --help display help for command

**Commands**:

| Command | Description |
| ---- | ---- |
| init [environment] | create/update the config file for analysis in your current folder |
| login [environment] | login to your account and store profile_token in the .tago/tago-lock |
| set-env [environment] | set your default environment from tagoconfig.ts |
| list-env | list all your environment and show current default |
| | |
| **Analysis** | |
| deploy, analysis-deploy [name] | deploy your analysis to TagoIO |
| run, analysis-run [name] | run your TagoIO analysis from your machine. |
| at, analysis-trigger [name] | send a signal to trigger your analysis TagoIO |
| ac, analysis-console [name] | connect to your Analysis Console |
| ad, analysis-duplicate [ID] | duplicate your Analysis |
| am, analysis-mode [name] | change an analysis or group of analysis to run on tago/external |
| | |
| **Devices** | |
| inspect, device-inspector [ID/Token] | connect to your Device Live Inspector |
| info, device-info [ID/Token] | get information about a device and it's configuration parameters |
| dl, device-list | get the list of devices |
| data [ID/Token] | get data from a device |
| bkp, device-backup [ID/Token] | backup data from a Device. Store it on the TagoIO Cloud by default |
| device-type [ID/Token] | change the bucket type to immutable or mutable |
| |
| **Profiles** | |
| export, app-export | export an application from one profile to another |
| Command | Description |
| ------------------------------------ | -------------------------------------------------------------------- |
| init [environment] | create/update the config file for analysis in your current folder |
| login [environment] | login to your account and store profile_token in the .tago/tago-lock |
| set-env [environment] | set your default environment from tagoconfig.ts |
| list-env | list all your environment and show current default |
| | |
| **Analysis** | |
| deploy, analysis-deploy [name] | deploy your analysis to TagoIO |
| run, analysis-run [name] | run your TagoIO analysis from your machine. |
| at, analysis-trigger [name] | send a signal to trigger your analysis TagoIO |
| ac, analysis-console [name] | connect to your Analysis Console |
| ad, analysis-duplicate [ID] | duplicate your Analysis |
| am, analysis-mode [name] | change an analysis or group of analysis to run on tago/external |
| | |
| **Devices** | |
| inspect, device-inspector [ID/Token] | connect to your Device Live Inspector |
| info, device-info [ID/Token] | get information about a device and it's configuration parameters |
| dl, device-list | get the list of devices |
| data [ID/Token] | get data from a device |
| bkp, device-backup [ID/Token] | backup data from a Device. Store it on the TagoIO Cloud by default |
| device-type [ID/Token] | change the bucket type to immutable or mutable |
| |
| **Profiles** | |
| export, app-export | export an application from one profile to another |

## Analysis Runner

When writing up your analysis, make sure you have the following lines at end of the code:

```javascript
Analysis.use(startAnalysis, { token: process.env.T_ANALYSIS_TOKEN });

```

If you want to use the Debugger with -D, make sure you have a **.swcrc** file with sourceMaps activated. This repository contains a .swcrc.example file if you prefer to just copy to your folder.
Expand All @@ -103,20 +107,21 @@ If you want to use the Debugger with -D, make sure you have a **.swcrc** file wi
Managing multiple environments is a breeze with the TagoIO CLI. This feature facilitates seamless alternation between different environments for deployment and analysis management. Here's how you can make the most of it:

### Creating a New Environment

To set up a new environment, use the `tagoio init` command. This will guide you through the necessary steps to establish a fresh environment for your project. Here's how you can do it:

```sh
tagoio init
```

### Switching Between Environments

If you are working with multiple environments, switching between them is essential. Use the `tagoio set-env` command to change your current environment effortlessly. Here's the command to use:

```sh
tagoio set-env [environment_name]
```


## Credentials Storage

Securing your credentials is a critical aspect of working with the TagoIO CLI. The CLI ensures the safe storage of your Profile-Token, which is vital for accessing various functionalities. Here's how the credentials storage works:
Expand All @@ -126,13 +131,13 @@ Securing your credentials is a critical aspect of working with the TagoIO CLI. T
When you execute commands like `tagoio login` or `tagoio init`, the CLI securely stores your Profile-Token in the current folder accessed by your terminal. Here's a brief on these commands:

1. **tagoio login**: This command allows you to log in to your account, storing the profile token in the process.

```sh
tagoio login
```

2. **tagoio init**: This command initiates the creation of a new project, during which you will be prompted to enter your credentials, generating a Profile-Token.

```sh
tagoio init
```
Expand All @@ -142,6 +147,7 @@ When you execute commands like `tagoio login` or `tagoio init`, the CLI securely
The stored Profile-Token is encrypted and saved in a file named `.tago-lock.{env}.lock`, ensuring the security of your sensitive information.

## tagoconfig.json

The `tagoconfig.json` file serves as the central configuration file for your JavaScript or TypeScript project when working with the TagoIO CLI. This file contains vital information about your analysis, including their IDs and names. Here's how you can set up and utilize the `tagoconfig.json` file effectively:

### Creating the tagoconfig.json File
Expand All @@ -152,6 +158,9 @@ To create a `tagoconfig.json` file, initiate your project using the `tagoio init
tagoio init
```

If you are using the TagoIO Deploy service, you can configure the URL:

- To configure the URL for the TagoIO Deploy service, update the `tagoDeployUrl` field in the `tagoconfig.json` file with the URL of your server to utilize your API.

### File Contents

Expand All @@ -166,24 +175,23 @@ The `tagoconfig.json` file encapsulates information about your current project,
Having a `tagoconfig.json` file is essential for executing several commands, such as:

- **tagoio deploy**: This command deploys your project to the TagoIO platform.

```sh
tagoio deploy
```

- **tagoio trigger**: Use this command to trigger specific actions or events in your project.

```sh
tagoio trigger
```

- **tagoio run**: This command allows you to run your project locally for testing and development.

```sh
tagoio run
```


## License

TagoIO SDK for JavaScript in the browser and Node.js is released under the [Apache-2.0 License](https://github.com/tagoio-cli/blob/master/LICENSE.md).

0 comments on commit 2ea394d

Please sign in to comment.