> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# circleci/irc

This orb is no longer supported by CircleCI 
because of limited or no use. If you would 
like to use this orb or create your own version 
feel free to fork the repository and use the 
following https://circleci.com/blog/building-private-orbs/ 
as a guide to making this orb into a private orb 
for your own use. 
Send custom IRC notifications from CircleCI.

## Commands

### notify

Send a custom message to an IRC channel or user.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `channel` | string |  | The IRC channel to post in. |
| `message` | string | Your CircleCI job has completed. | Message to send. |
| `nick` | string | circleci-bot | IRC nick. |
| `pass` | env_var_name | IRC_SERVER_PASSWORD | Name of the environment variable containing the IRC server password. |
| `port` | integer | 6667 | IRC server port. Defaults to 6667. |
| `server` | string | ${IRC_SERVER} | The IRC server to connect to. Defaults to the environment variable 'IRC_SERVER'. |

## Examples

### notify

Send a notification to an IRC channel


```yaml
version: '2.1'
orbs:
  irc: circleci/irc@x.y.z
jobs:
  build:
    docker:
      - image: your-image
    steps:
      - checkout
      - irc/notify:
          channel: circle-notify
          message: Build completed!
          nick: circleci-bot
          port: 6667
          server: 127.0.0.1
workflows:
  your-workflow:
    jobs:
      - build
```