https://github.com/digital-alchemy-ts/type-writer

Type generation tool for Home Assistant
https://github.com/digital-alchemy-ts/type-writer

application digital-alchemy home-assistant home-automation nodejs typescipt

Last synced: 1 day ago
JSON representation

Type generation tool for Home Assistant

• Host: GitHub
• URL: https://github.com/digital-alchemy-ts/type-writer
• Owner: Digital-Alchemy-TS
• License: mit
• Created: 2024-03-10T04:19:45.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-25T04:15:11.000Z (5 months ago)
• Last Synced: 2024-04-25T10:10:17.531Z (5 months ago)
• Topics: application, digital-alchemy, home-assistant, home-automation, nodejs, typescipt
• Language: TypeScript
• Homepage: https://docs.digital-alchemy.app/Type-Writer
• Size: 1.34 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
Welcome to `@digital-alchemy/type-writer`!

This application acts a support application for [@digital-alchemy/hass](https://github.com/Digital-Alchemy-TS/hass), providing type definitions to assist during development

- [Project docs](https://docs.digital-alchemy.app)

- [Discord](https://discord.gg/JkZ35Gv97Y)

![editor](./docs/editor.png)

## 🚀 Usage

```bash

# install to devDependencies

npm i --save-dev @digital-alchemy/type-writer

# run

npx type-writer

```

![command](./docs/command.png)

If you are running your code within a Home Assistant addon environment, `type-writer` will automatically connect to your install. No configuration needed!

## ⚙️ Configuration

For setups outside an addon environment, a configuration file is needed. Create one of the following:

- `.type_writer`: add to project root

- `~/.config/type_writer`: add to user configs

**Contents:**

```ini

[hass]

  BASE_URL=http://localhost:8123

  TOKEN=... # YOUR LONG LIVED ACCESS TOKEN

```