0.6.13 • Published 8 months ago

@dxos/cli v0.6.13

Weekly downloads
193
License
MIT
Repository
-
Last release
8 months ago

DX CLI

DXOS command line interface.

Installation

npm install -g @dxos/cli@main

Agent

See main docs at Agents

Running an agent as a system service

Start an agent as a system daemon via CLI command

Agent could be started as a system daemon via cli command:

dx agent start --system

This command will run an agent as launchd service (macOS users) or as a systemd service (Linux users).

Other useful commands:

dx agent list --system
dx agent restart --system
dx agent stop --system

Alternatively, manual setup could be used (see below).

Install agent as a launchd service (macOS users) - manual setup

  1. Install DXOS CLI with steps in Installation section.
  2. Replace ??NODE_PATH?? in "./init-templates/org.dxos.agent.plist" with output of command dirname $(which node)
  3. Replace ??DX_PATH?? in "./init-templates/org.dxos.agent.plist" with output of command which dx
  4. Copy ./init-templates/org.dxos.agent.plist -> ~/Library/LaunchAgents/org.dxos.agent.plist
  5. Run launchctl load -w ~/Library/LaunchAgents/org.dxos.agent.plist

Stop agent started by launchd

  1. Run launchctl unload -w ~/Library/LaunchAgents/org.dxos.agent.plist
  2. Remove ~/Library/LaunchAgents/org.dxos.agent.plist

Install agent as a systemd service (Linux users) - manual setup

  1. Install DXOS CLI with steps in Installation section.
  2. Copy ./init-templates/dxos-agent.service and ./init-templates/pre-dxos-agent.service -> ~/.config/systemd/user/
  3. Run systemctl --user daemon-reload to make the systemd daemon aware of the service
  4. Run systemctl --user enable dxos-agent to enable the service to start automatically
  5. Optionally, run sudo loginctl enable-linger {USERNAME} to enable the service to start without user login (replace {USERNAME} with the name of the user that will run the service)
  6. Run systemctl --user start dxos-agent to start the service

Start agent with CLI

Agent is automatically started by each command that requires Client (to avoid this behavior use --no-agent flag). You can use --profile flag (default value is default) to run agent in an isolated profile, and --foreground to run agent in attached process.

dx agent start

see: dx agent start

Adding Agent to your Composer Identity

  1. Go to Composer. And create a device invitation. Composer add device Composer invitation

  2. Run halo join command in your terminal. CLI halo join flow

  3. Proceed with invitation

Troubleshooting

  1. Make sure you are running the latest version of the shared worker in the browser. Go to the shared workers tab chrome://inspect/#workers, kill dxos-vault worker, then reload the Composer tab.
  2. Restart your agent with dx agent restart. Also useful command dx agent stop --all

Danger Zone

  1. Reset Storage. Warning: Agent will lose its storage, and config file will be deleted dx reset --force

Development

Multiple Profile configuration

Both the CLI and agents can be configured to use a given profile using either the --profile flag or DX_PROFILE environment variable. The CLI will automatically connect to the agent using the given profile.

Local development

The CLI can be invoked out of the Git monorepo using the bin/dev command.

Source the following script to set an alias for dx that can be called from any directory:

cd packages/devtools/cli
. ../../devtools/cli/scripts/dev.sh

Example:

DX_PROFILE=test dx agent start  --ws=4567

NOTE: The agent will need to be recompiled after any changes.

Building

To build the CLI:

nx run cli:build --watch=true

Devtools

The agent can be configured to expose a Websocket port using the --ws flag that can be connected to using DXOS Devtools:

To connect devtools, set the target query parameter to the agent's websocket URL, e.g.,

https://devtools.dxos.org?target=ws://localhost:4567

Debugging

To enable logging, set LOG_FILTER:

LOG_FILTER=info,agent:debug dx agent start -f

If the agent is run in background mode, log files will be created in /tmp/dx/run/profile/<profile name>/logs

To enable the node debugger, set NODE_OPTIONS then open in VSCode (CMD-SHIFT-P "Attach to Node process").

NODE_OPTIONS="--inspect-brk"

Reporting errors

Run the following command to create a gist of the debug stats.

dx debug stats --json --no-agent | gh gist create
0.6.13

8 months ago

0.6.12

9 months ago

0.5.9-main.7be09a9

12 months ago

0.6.2-main.6f40bfd

12 months ago

0.6.1-main.04e8aa0

12 months ago

0.6.3-main.d007b87

12 months ago

0.6.3-main.98b0ce6

12 months ago

0.6.3-main.40d1cec

12 months ago

0.6.2-main.bd2f985

12 months ago

0.5.4

1 year ago

0.5.3

1 year ago

0.5.6

1 year ago

0.5.5

1 year ago

0.5.0

1 year ago

0.5.2

1 year ago

0.6.1-main.ff751ec

12 months ago

0.6.2-main.5631d96

12 months ago

0.6.8-main.3be982f

10 months ago

0.6.2-main.86c20e9

12 months ago

0.6.8-main.046e6cf

10 months ago

0.6.3-main.d76104f

11 months ago

0.6.2-main.bd4e5d2

12 months ago

0.6.1-main.de77b30

12 months ago

0.6.3-main.9e4e207

12 months ago

0.6.3-main.28bccc4

12 months ago

0.5.9-main.5ad2d33

12 months ago

0.6.2-main.fb91371

12 months ago

0.6.3-main.3c9610d

12 months ago

0.5.9-main.c837b46

12 months ago

0.6.1-main.c52e5db

12 months ago

0.6.1-main.fac53f5

12 months ago

0.6.3-main.7853476

11 months ago

0.6.3-main.0308ae2

11 months ago

0.5.8

1 year ago

0.5.7

1 year ago

0.6.3-main.038c693

12 months ago

0.6.1-main.7c5f65a

12 months ago

0.6.3-main.0dc8689

11 months ago

0.6.3-main.6906e91

12 months ago

0.6.2-main.c820d78

12 months ago

0.3.10

1 year ago

0.6.1-main.18a8c5d

12 months ago

0.6.1-main.e985410

12 months ago

0.6.2-main.5b838e6

12 months ago

0.6.1-main.358d1ca

12 months ago

0.6.3-next.4424131

11 months ago

0.6.3-main.84ed9fe

12 months ago

0.6.3-main.258ac4c

12 months ago

0.6.1-next.f8e935e

12 months ago

0.6.1-main.23da23a

12 months ago

0.6.3-main.0af171d

12 months ago

0.6.1-main.d9fdca4

12 months ago

0.6.1-main.6af17d0

12 months ago

0.6.1-main.c633aeb

12 months ago

0.6.1-main.e05b43b

12 months ago

0.6.3-main.c9047c0

12 months ago

0.5.9-main.c7dd658

12 months ago

0.6.2-main.c53e208

12 months ago

0.6.1-main.2717aa2

12 months ago

0.6.2-main.d448994

12 months ago

0.6.3-main.b88405e

12 months ago

0.5.9-main.bf3bb8f

12 months ago

0.6.3-main.226a8ae

12 months ago

0.4.9

1 year ago

0.4.8

1 year ago

0.6.1-main.e0f3bcf

12 months ago

0.6.1-main.a5cf05f

12 months ago

0.6.1-main.2058386

12 months ago

0.4.5

1 year ago

0.4.4

1 year ago

0.4.7

1 year ago

0.4.6

1 year ago

0.4.1

1 year ago

0.4.0

1 year ago

0.4.3

1 year ago

0.4.2

1 year ago

0.5.9-main.b752d7f

12 months ago

0.5.9-main.c27c306

12 months ago

0.6.1-main.7d86e7f

12 months ago

0.6.3-main.d1c1553

11 months ago

0.6.1-main.4211093

12 months ago

0.6.2-main.f3edf77

12 months ago

0.5.9-main.bdb299c

12 months ago

0.6.3-main.0ca5117

12 months ago

0.6.2-main.5b5129c

12 months ago

0.6.1-main.09a92b0

12 months ago

0.6.3-main.4203f37

11 months ago

0.6.2-main.e09770c

12 months ago

0.6.2-main.000b1cc

12 months ago

0.6.2-main.52eb594

12 months ago

0.6.1-main.1d7c589

12 months ago

0.6.6-main.e1a6e1f

11 months ago

0.6.2-main.8a232a5

12 months ago

0.6.3-next.2f65b78

12 months ago

0.1.52

2 years ago

0.1.53

2 years ago

0.1.54

2 years ago

0.1.55

2 years ago

0.1.56

2 years ago

0.1.57

2 years ago

0.1.51

2 years ago

0.6.1-main.ee05489

12 months ago

0.6.1-main.be5a845

12 months ago

0.3.0

2 years ago

0.3.6

2 years ago

0.3.5

2 years ago

0.3.8

2 years ago

0.3.7

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.4

2 years ago

0.3.3

2 years ago

0.3.9

2 years ago

0.6.1-main.faf01b2

12 months ago

0.6.3-main.d16c079

11 months ago

0.6.2-main.c33bf0c

12 months ago

0.6.1-main.e8ba54c

12 months ago

0.6.2-main.d41f0d2

12 months ago

0.6.1-main.84b4a5e

12 months ago

0.6.3-next.1b3691b

11 months ago

0.6.7

10 months ago

0.6.6

10 months ago

0.6.9

10 months ago

0.6.8

10 months ago

0.5.9-next.912f1ef

12 months ago

0.6.1-main.f8e935e

12 months ago

0.5.9-main.912f1ef

12 months ago

0.6.2-main.11917b6

12 months ago

0.6.3

11 months ago

0.6.2

12 months ago

0.6.5

11 months ago

0.6.4

11 months ago

0.6.1

12 months ago

0.6.0

12 months ago

0.6.3-main.cc41ccb

12 months ago

0.6.1-main.2c1a092

12 months ago

0.6.3-main.fe243fc

12 months ago

0.6.1-main.babcd84

12 months ago

0.5.9-main.1c50f63

12 months ago

0.5.9-next.73dcc17

12 months ago

0.6.3-main.a95c491

11 months ago

0.6.1-main.92dcbbe

12 months ago

0.6.10

10 months ago

0.6.11

9 months ago

0.6.1-main.5f81d7a

12 months ago

0.6.3-main.8eec022

11 months ago

0.6.2-main.1f6dcc6

12 months ago

0.6.3-main.daaea86

12 months ago

0.6.2-next.5b5129c

12 months ago

0.6.3-main.e6314a6

12 months ago

0.6.1-main.64a1e07

12 months ago

0.2.1

2 years ago

0.2.0

2 years ago

0.2.3

2 years ago

0.1.50

2 years ago

0.1.49

2 years ago

0.1.41

2 years ago

0.1.45

2 years ago

0.1.46

2 years ago

0.1.47

2 years ago

0.1.48

2 years ago

0.1.40

2 years ago

0.1.38

2 years ago

0.1.39

2 years ago

0.1.30

2 years ago

0.1.31

2 years ago

0.1.33

2 years ago

0.1.34

2 years ago

0.1.35

2 years ago

0.1.36

2 years ago

0.1.37

2 years ago

0.1.27

2 years ago

0.1.28

2 years ago

0.1.29

2 years ago

0.1.24

2 years ago

0.1.25

2 years ago

0.1.26

2 years ago

0.1.14

3 years ago

0.1.20

3 years ago

0.1.21

2 years ago

0.1.22

2 years ago

0.1.23

2 years ago

0.1.16

3 years ago

0.1.17

3 years ago

0.1.18

3 years ago

0.1.19

3 years ago

0.1.10

3 years ago

0.1.11

3 years ago

0.1.12

3 years ago

0.1.13

3 years ago

0.1.1

3 years ago

0.1.8

3 years ago

0.1.7

3 years ago

0.1.9

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.6

3 years ago

0.1.5

3 years ago

2.20.2

3 years ago

2.20.3

3 years ago

2.20.4

3 years ago

2.20.0

3 years ago

2.20.1

3 years ago

2.19.0

3 years ago

2.18.3

3 years ago

2.18.4

3 years ago

2.18.1

3 years ago

2.18.2

3 years ago

2.18.0

3 years ago

2.17.0

3 years ago

2.16.9

3 years ago

2.16.8

3 years ago

2.16.7

3 years ago

2.16.5

3 years ago

2.16.6

3 years ago

2.16.3

3 years ago

2.16.4

3 years ago

2.16.1

3 years ago

2.16.2

3 years ago

2.11.4

4 years ago

2.11.5

3 years ago

2.11.3

4 years ago

2.13.14

3 years ago

2.13.13

3 years ago

2.13.12

3 years ago

2.13.11

3 years ago

2.13.10

3 years ago

2.16.0

3 years ago

2.15.0

3 years ago

2.14.3

3 years ago

2.14.1

3 years ago

2.14.2

3 years ago

2.14.0

3 years ago

2.13.8

3 years ago

2.13.9

3 years ago

2.13.6

3 years ago

2.13.7

3 years ago

2.13.4

3 years ago

2.13.5

3 years ago

2.13.2

3 years ago

2.13.3

3 years ago

2.13.0

3 years ago

2.13.1

3 years ago

2.12.0

3 years ago

2.12.3

3 years ago

2.12.4

3 years ago

2.12.1

3 years ago

2.12.2

3 years ago

2.11.1

4 years ago

2.10.0

4 years ago

2.11.1-alpha.0

4 years ago

2.11.3-alpha.0

4 years ago

2.10.0-alpha.0

4 years ago

2.11.0-alpha.0

4 years ago

2.9.5-alpha.0

4 years ago

2.11.2-alpha.0

4 years ago

2.10.0-beta.0

4 years ago

2.8.7-alpha.0

4 years ago

2.9.1-alpha.0

4 years ago

2.8.10-alpha.0

4 years ago

2.9.3-alpha.0

4 years ago

2.8.5-alpha.0

4 years ago

2.9.0-alpha.0

4 years ago

2.8.8-alpha.0

4 years ago

2.8.6-alpha.0

4 years ago

2.9.2-alpha.0

4 years ago

2.8.9-alpha.0

4 years ago

2.9.4-alpha.0

4 years ago

2.8.4-alpha.0

4 years ago

2.8.3-alpha.0

4 years ago

2.8.2-alpha.0

4 years ago

2.8.0-alpha.0

4 years ago

2.8.1-alpha.0

4 years ago

2.6.8-alpha.0

4 years ago

2.6.0-alpha.0

4 years ago

2.6.3-alpha.0

4 years ago

2.7.0-alpha.0

4 years ago

2.6.2-alpha.0

4 years ago

2.6.5-alpha.0

4 years ago

2.6.4-alpha.0

4 years ago

2.6.7-alpha.0

4 years ago

2.5.1-alpha.0

4 years ago

2.6.6-alpha.0

4 years ago

2.6.9-alpha.0

4 years ago

2.7.1-alpha.0

4 years ago

2.6.1-alpha.0

4 years ago

2.5.0-alpha.0

4 years ago

2.4.15-beta.0

4 years ago

2.4.15

4 years ago

2.4.15-alpha.0

4 years ago

2.4.14-alpha.0

4 years ago

2.4.12-alpha.0

4 years ago

2.4.13

4 years ago

2.4.13-beta.0

4 years ago

2.4.13-alpha.0

4 years ago

2.4.11-alpha.0

4 years ago

2.4.10-alpha.0

4 years ago

2.4.9-alpha.0

4 years ago

2.4.8-alpha.0

4 years ago

2.4.7-test.0

4 years ago

2.4.7

4 years ago

2.4.7-alpha.0

4 years ago

2.4.7-beta.0

4 years ago

2.4.6

4 years ago

2.4.6-beta.0

4 years ago

2.4.5-alpha.0

4 years ago

2.4.6-alpha.0

4 years ago

2.4.4

4 years ago

2.4.4-alpha.0

4 years ago

2.4.4-beta.0

4 years ago

2.4.3-alpha.0

4 years ago

2.4.3-beta.0

4 years ago

2.4.2-alpha.0

4 years ago

2.4.1

4 years ago

2.4.1-beta.0

4 years ago

2.4.1-alpha.0

4 years ago

2.4.0-alpha.0

4 years ago

2.3.1-beta.0

4 years ago

2.3.1-alpha.0

4 years ago

2.3.0-alpha.0

4 years ago

2.2.2-alpha.0

4 years ago

2.2.1-alpha.0

4 years ago

2.2.0-alpha.0

4 years ago

2.1.6-alpha.0

4 years ago

2.1.5-alpha.0

4 years ago

2.1.3-alpha.0

4 years ago

2.1.4-alpha.0

4 years ago

2.1.2-alpha.0

4 years ago

2.0.62-alpha.0

4 years ago

2.0.58-alpha.0

4 years ago

2.1.1-alpha.0

4 years ago

2.0.60-alpha.0

4 years ago

2.0.59-alpha.0

4 years ago

2.0.61-alpha.0

4 years ago

2.1.0-alpha.0

4 years ago

2.0.57-alpha.0

4 years ago

2.0.56-alpha.0

4 years ago

2.0.55-alpha.0

4 years ago

2.0.54-alpha.0

4 years ago

2.0.49-alpha.0

4 years ago

2.0.50-alpha.0

4 years ago

2.0.45-alpha.0

4 years ago

2.0.53-alpha.0

4 years ago

2.0.48-alpha.0

4 years ago

2.0.44-alpha.0

4 years ago

2.0.52-alpha.0

4 years ago

2.0.47-alpha.0

4 years ago

2.0.43-alpha.0

4 years ago

2.0.51-alpha.0

4 years ago

2.0.46-alpha.0

4 years ago

2.0.42-alpha.0

4 years ago

2.0.41-alpha.0

4 years ago

2.0.40-alpha.0

4 years ago

2.0.39-alpha.0

4 years ago

2.0.38-alpha.0

4 years ago

2.0.37-alpha.0

4 years ago

2.0.36-alpha.0

4 years ago

2.0.35-alpha.0

4 years ago

2.0.34-alpha.0

5 years ago

2.0.33-alpha.0

5 years ago

2.0.32

5 years ago

2.0.32-alpha.0

5 years ago

2.0.32-beta.0

5 years ago

2.0.30-alpha.0

5 years ago

2.0.30-beta.0

5 years ago

2.0.31-alpha.0

5 years ago

2.0.29-alpha.0

5 years ago

2.0.28-alpha.0

5 years ago

2.0.27-alpha.0

5 years ago

2.0.26-alpha.0

5 years ago

2.0.25-alpha.0

5 years ago

2.0.24-beta.0

5 years ago

2.0.24-alpha.0

5 years ago

2.0.24

5 years ago

2.0.22-alpha.0

5 years ago

2.0.23-alpha.0

5 years ago

2.0.21-alpha.0

5 years ago

2.0.20-beta.0

5 years ago

2.0.20

5 years ago

2.0.20-alpha.0

5 years ago

2.0.19-alpha.0

5 years ago

2.0.18-alpha.0

5 years ago

2.0.17-alpha.0

5 years ago

2.0.16-beta.0

5 years ago

2.0.17-beta.0

5 years ago

2.0.16-alpha.0

5 years ago

2.0.15-alpha.0

5 years ago

2.0.16

5 years ago

2.0.17

5 years ago

2.0.14-alpha.0

5 years ago

2.0.13-alpha.0

5 years ago

2.0.12-alpha.0

5 years ago

2.0.9-alpha.0

5 years ago

2.0.10-alpha.0

5 years ago

2.0.8

5 years ago

2.0.8-beta.0

5 years ago

2.0.8-alpha.0

5 years ago

2.0.7

5 years ago

2.0.7-alpha.0

5 years ago

2.0.6-alpha.0

5 years ago

2.0.5-alpha.0

5 years ago

2.0.4-alpha.0

5 years ago

2.0.3-beta.0

5 years ago

2.0.3

5 years ago

2.0.2

5 years ago

2.0.3-alpha.0

5 years ago

2.0.2-beta.0

5 years ago

2.0.2-alpha.0

5 years ago

2.0.1-alpha.0

5 years ago

1.1.0-beta.11

5 years ago

1.1.0-beta.10

5 years ago

1.1.0-beta.9

5 years ago

1.1.0-beta.8

5 years ago

1.1.0-beta.7

5 years ago

1.1.0-beta.6

5 years ago

1.1.0-beta.5

5 years ago

1.1.0-beta.4

5 years ago

1.1.0-beta.2

5 years ago

1.1.0-beta.3

5 years ago

1.1.0-beta.1

5 years ago

1.1.0-beta.0

5 years ago

1.0.1-moon.8

5 years ago

1.0.1-moon.7

5 years ago

1.0.1-moon.6

5 years ago

1.0.1-moon.5

5 years ago

1.0.1-moon.4

5 years ago

1.0.1-moon.3

5 years ago

1.0.1-moon.2

5 years ago

1.0.1-moon.1

5 years ago

1.0.1-moon.0

5 years ago

1.0.1-beta.31

5 years ago

1.0.1-beta.30

5 years ago

1.0.1-beta.29

5 years ago

1.0.1-beta.28

5 years ago

1.0.1-beta.27

5 years ago

1.0.1-beta.26

5 years ago

1.0.1-beta.25

5 years ago

1.0.1-beta.24

5 years ago

1.0.1-beta.23

5 years ago

1.0.1-beta.22

5 years ago

1.0.1-beta.21

5 years ago

1.0.1-beta.20

5 years ago

1.0.1-beta.19

5 years ago

1.0.1-beta.18

5 years ago

1.0.1-beta.17

5 years ago

1.0.1-beta.16

5 years ago

1.0.1-beta.15

5 years ago

1.0.1-beta.14

5 years ago

1.0.1-beta.13

5 years ago

1.0.1-beta.12

5 years ago

1.0.1-beta.11

5 years ago

1.0.1-beta.10

5 years ago

1.0.1-beta.9

5 years ago

1.0.1-beta.8

5 years ago

1.0.1-beta.7

5 years ago

1.0.1-beta.6

5 years ago

1.0.1-beta.5

5 years ago

1.0.1-beta.4

5 years ago

1.0.1-beta.2

5 years ago

1.0.1-beta.1

5 years ago

1.0.1-beta.3

5 years ago

1.0.0-beta.68

5 years ago

1.0.0-beta.66

5 years ago

1.0.0-beta.67

5 years ago

1.0.0-beta.65

5 years ago

1.0.0-beta.64

5 years ago

1.0.0-beta.63

5 years ago

1.0.0-beta.62

5 years ago

1.0.0-beta.60

5 years ago

1.0.0-beta.61

5 years ago

1.0.0-beta.56

5 years ago

1.0.0-beta.59

5 years ago

1.0.0-beta.57

5 years ago

1.0.0-beta.58

5 years ago

1.0.0-beta.55

5 years ago

1.0.0-beta.54

5 years ago

1.0.0-beta.53

5 years ago

1.0.0-beta.52

5 years ago

1.0.0-beta.51

5 years ago

1.0.0-beta.48

5 years ago

1.0.0-beta.49

5 years ago

1.0.0-beta.47

5 years ago

1.0.0-beta.50

5 years ago

1.0.0-beta.46

5 years ago

1.0.0-beta.44

5 years ago

1.0.0-beta.45

5 years ago

1.0.0-beta.43

5 years ago

1.0.0-beta.42

5 years ago

1.0.0-beta.41

5 years ago

1.0.0-beta.40

5 years ago

1.0.0-beta.39

5 years ago

1.0.0-beta.37

5 years ago

1.0.0-beta.35

5 years ago

1.0.0-beta.33

5 years ago

1.0.0-beta.34

5 years ago

1.0.0-beta.31

5 years ago

1.0.0-beta.32

5 years ago

1.0.0-beta.30

5 years ago

1.0.0-beta.29

5 years ago

1.0.0-beta.28

5 years ago

1.0.0-beta.27

5 years ago

1.0.0-beta.26

5 years ago

1.0.0-beta.25

5 years ago

1.0.0-beta.24

5 years ago

1.0.0-beta.23

5 years ago

1.0.0-beta.22

5 years ago

1.0.0-beta.21

5 years ago

1.0.0-beta.20

5 years ago

1.0.0-beta.19

5 years ago

1.0.0-beta.16

5 years ago

1.0.0-beta.15

5 years ago

1.0.0-beta.14

5 years ago

1.0.0-beta.13

5 years ago

1.0.0-beta.11

5 years ago