directus/cli

Directus Client CLI

---

🐰 Introduction

Directus is a real-time API and App dashboard for managing SQL database content.

• Open Source. No artificial limitations, vendor lock-in, or hidden paywalls.
• REST & GraphQL API. Instantly layers a blazingly fast Node.js API on top of any SQL database.
• Manage Pure SQL. Works with new or existing SQL databases, no migration required.
• Choose your Database. Supports PostgreSQL, MySQL, SQLite, OracleDB, CockroachDB, MariaDB, and MS-SQL.
• On-Prem or Cloud. Run locally, install on-premises, or use our self-service Cloud service.
• Completely Extensible. Built to white-label, it is easy to customize our modular platform.
• A Modern Dashboard. Our no-code Vue.js app is safe and intuitive for non-technical users, no training required.

Learn more about Directus • Documentation

🚀 Directus Cloud

Directus Cloud allows you to create projects, hosted by the Directus team, in 90 seconds.

• No product limitations or service usage quotas (unlimited users, API requests, etc)
• A modern self-service dashboard to create and monitor all your projects in one place
• End-to-end solution: Directus, database, serverless auto-scaling, storage, and a global CDN
• Select your desired region and provision a new project in ~90 seconds

Create a Directus Cloud Project

🤔 Community Help

The Directus Documentation is a great place to start, or explore these other channels:

• Discord (Questions, Live Discussions)
• GitHub Issues (Report Bugs)
• GitHub Discussions (Feature Requests)
• Twitter (Latest News)
• YouTube (Video Tutorials)

❤️ Contributing & Sponsoring

Please read our Contributing Guide before submitting Pull Requests.

All security vulnerabilities should be reported in accordance with our Security Policy.

Directus is a premium open-source (BSL 1.1) project, made possible with support from our passionate core team, talented contributors, and amazing GitHub Sponsors. Thank you all!!

© 2004-2024, Monospace, Inc.

cli's Issues

No commands available or listed.

Note: I am running this on Windows.

Firstly, after installation, I get warnings about 2 vulnerabilities:

npm WARN deprecated @types/[email protected]: This is a stub types definition. pino provides its own type definitions, so you do not need this installed.
npm WARN deprecated [email protected]: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

added 412 packages, and audited 413 packages in 1m

42 packages are looking for funding
  run `npm fund` for details

2 critical severity vulnerabilities

To address all issues (including breaking changes), run:
  npm audit fix --force

Run `npm audit` for details.

Then, when I try to run a command using npx directusctl instance connect:

 ERROR 
  Unknown command: "directusctl instance connect"

When I run --help, no commands are listed:

 SYNOPSIS 

  directusctl <command> [options]

 COMMANDS 
  These are all the commands you can use to manage your project or
  installation


 OPTIONS 

  --help  boolean  Show help for the specified command

Thank you!

TypeError: freeParser.getUsageInstance is not a function

First of all, command outputs are not written to screen.
I've added console.log(error) here to so cli shows what I'm doing wrong and now for commands that use instance connections (instance info, instance list) output is:

TypeError: freeParser.getUsageInstance is not a function
    at Options.list (C:\Users\xxx\AppData\Roaming\npm\node_modules\@directus\cli\dist\core\options.js:64:34)
    at Help.getCommandHelp (C:\Users\xxx\AppData\Roaming\npm\node_modules\@directus\cli\dist\core\help.js:168:35)
    at Command.run (C:\Users\xxx\AppData\Roaming\npm\node_modules\@directus\cli\dist\core\command.js:75:39)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)

I've looked up references to this function and indeed it seems that it's not defined anywhere in the package

node 16.18.0
os: windows

CLI package doesn't work

Describe the Bug

CLI Client doesn't work

To Reproduce

npx directusctl

or

npx @directus/cli

See docs > CLI > Client

Errors Shown

for npx directusctl console shows

Not Found - GET https://registry.npmjs.org/directusctl - Not found

  'directusctl@latest' is not in this registry.

Note that you can also install from a
404 tarball, folder, http url, or git url.

for npx @directus/cli console shows

declare const _default: import("../..").Command<import("../..").Toolbox<import("@directus/sdk").TypeMap>, unknown, void>;
        ^^^^^

SyntaxError: Unexpected token 'const'
    at Object.compileFunction (node:vm:352:18)
    at wrapSafe (node:internal/modules/cjs/loader:1033:15)
    at Module._compile (node:internal/modules/cjs/loader:1069:27)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1159:10)
    at Module.load (node:internal/modules/cjs/loader:981:32)
    at Function.Module._load (node:internal/modules/cjs/loader:822:12)
    at Module.require (node:internal/modules/cjs/loader:1005:19)
    at require (node:internal/modules/cjs/helpers:102:18)
    at loadModule (C:\Users\xxx\AppData\Local\npm-cache\_npx\34e488e770b21435\node_modules\gluegun\build\loaders\module-loader.js:15:12)
    at loadCommandFromFile (C:\Users\xxx\AppData\Local\npm-cache\_npx\34e488e770b21435\node_modules\gluegun\build\loaders\command-loader.js:41:56)

What version of Directus are you using?

9.14.1

What version of Node.js are you using?

16.16

What database are you using?

MySQL 5.7.32

What browser are you using?

Chrome

How are you deploying Directus?

locally