├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── cli.js ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: macos-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: actions/setup-node@v4 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | import process from 'node:process'; 3 | import meow from 'meow'; 4 | import {activeWindow} from 'get-windows'; 5 | 6 | const cli = meow(` 7 | Usage 8 | $ active-window [property] 9 | 10 | Returns title, id, app, pid, or the specified property 11 | 12 | Examples 13 | $ active-window 14 | npm install 15 | 54 16 | Terminal 17 | 368 18 | $ active-window app 19 | Terminal 20 | `, { 21 | importMeta: import.meta, 22 | }); 23 | 24 | const returnValue = await activeWindow(); 25 | const validProperties = ['title', 'id', 'app', 'pid']; 26 | const property = cli.input[0]; 27 | 28 | if (!returnValue) { 29 | console.log('Could not find an active window.'); 30 | process.exit(1); 31 | } 32 | 33 | if (property) { 34 | if (!validProperties.includes(property)) { 35 | console.error(`Specify a valid property: ${validProperties.join(', ')}`); 36 | process.exit(1); 37 | } 38 | 39 | console.log(returnValue[property]); 40 | process.exit(); 41 | } 42 | 43 | console.log(`${returnValue.title}\n${returnValue.id}\n${returnValue.app}\n${returnValue.pid}`); 44 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "windows-cli", 3 | "version": "3.0.0", 4 | "description": "Get metadata about the active window (title, id, bounds, owner, URL, etc)", 5 | "license": "MIT", 6 | "repository": "sindresorhus/windows-cli", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "bin": { 15 | "active-window": "./cli.js" 16 | }, 17 | "engines": { 18 | "node": ">=18" 19 | }, 20 | "scripts": { 21 | "test": "xo && ava" 22 | }, 23 | "files": [ 24 | "cli.js" 25 | ], 26 | "keywords": [ 27 | "cli-app", 28 | "cli", 29 | "macos", 30 | "osx", 31 | "linux", 32 | "app", 33 | "application", 34 | "window", 35 | "win", 36 | "active", 37 | "focused", 38 | "current", 39 | "title", 40 | "name", 41 | "id", 42 | "pid", 43 | "screenshot", 44 | "screencapture" 45 | ], 46 | "dependencies": { 47 | "get-windows": "^9.1.1", 48 | "meow": "^13.2.0" 49 | }, 50 | "devDependencies": { 51 | "ava": "^6.1.2", 52 | "execa": "^8.0.1", 53 | "xo": "^0.58.0" 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # windows-cli 2 | 3 | > Get metadata about the [active window](https://en.wikipedia.org/wiki/Active_window) (title, id, bounds, owner, URL, etc) 4 | 5 | Works on macOS 10.14+, [Linux](https://github.com/sindresorhus/get-windows?tab=readme-ov-file#linux-support), and Windows 7+. 6 | 7 | ## Install 8 | 9 | ```sh 10 | npm install --global windows-cli 11 | ``` 12 | 13 | ## Usage 14 | 15 | ```console 16 | $ active-window --help 17 | 18 | Usage 19 | $ active-window [property] 20 | 21 | Returns title, id, app, pid, or the specified property 22 | 23 | Examples 24 | $ active-window 25 | npm install 26 | 54 27 | Terminal 28 | 368 29 | $ active-window app 30 | Terminal 31 | ``` 32 | 33 | ## Tip 34 | 35 | You can use the `id` property with the builtin `screencapture` CLI tool to screenshot the active window: 36 | 37 | ```sh 38 | screencapture -l$(active-window id) screenshot.png 39 | ``` 40 | 41 | ## Related 42 | 43 | - [get-windows](https://github.com/sindresorhus/get-windows) - API for this package 44 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import process from 'node:process'; 2 | import test from 'ava'; 3 | import {execa} from 'execa'; 4 | 5 | test('main', async t => { 6 | if (process.env.CI) { 7 | t.pass(); 8 | return; 9 | } 10 | 11 | const {stdout} = await execa('./cli.js'); 12 | t.is(stdout.split('\n').length, 4); 13 | }); 14 | 15 | test('property', async t => { 16 | if (process.env.CI) { 17 | t.pass(); 18 | return; 19 | } 20 | 21 | const {stdout} = await execa('./cli.js', ['app']); 22 | t.true(stdout.length > 0); 23 | }); 24 | --------------------------------------------------------------------------------